Skip to content

Commit 9b9a8bd

Browse files
stuarthendrenstuarthendren
committed
🎉 Version 1.0.0
Move to @committed scope
1 parent f5ff4f8 commit 9b9a8bd

22 files changed

+64
-58
lines changed

‎.drone.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ steps:
6464
webhook:
6565
from_secret: slack_webhook
6666
template: >
67-
:tada: New version ${DRONE_TAG} of `@commitd/docs` available http://committed.software/docs
67+
:tada: New version ${DRONE_TAG} of `@committed/docs` available, http://committed.software/docs
6868
when:
6969
ref:
7070
- refs/tags/v*

‎.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{
2+
}

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Here's a [live demo](https://committed.software/docs)
3636
Get started by adding the dependencies:
3737

3838
```bash
39-
yarn add @commitd/gatsby-theme-docs gatsby react react-dom
39+
yarn add @committed/gatsby-theme-docs gatsby react react-dom
4040
```
4141

4242
and configure in `gatsby-config.js` with your site metadata e.g.
@@ -51,7 +51,7 @@ module.exports = {
5151
},
5252
plugins: [
5353
{
54-
resolve: `@commitd/gatsby-theme-docs`,
54+
resolve: `@committed/gatsby-theme-docs`,
5555
options: {}
5656
}
5757
]

‎example/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# @commitd/gatsby-theme-docs example
1+
# @committed/gatsby-theme-docs example
22

33
See site at https://committed.software/docs
44

5-
The example show the usage and provides instructions for the [@commitd/gatsby-theme-docs](https://github.com/commitd/gatsby-theme-docs).
5+
The example show the usage and provides instructions for the [@committed/gatsby-theme-docs](https://github.com/commitd/gatsby-theme-docs).
66

77
## Development
88

‎example/docs/example2.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ Elements can use state:
4343
</CardContent>
4444
</Card>
4545

46-
[`@commitd/components`](https://committed.software/components) are available to use without imports.
46+
[`@committed/components`](https://committed.software/components) are available to use without imports.

‎example/docs/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
title: "Welcome"
3-
metaTitle: "@commitd/gatsgy-theme-docs"
3+
metaTitle: "@committed/gatsgy-theme-docs"
44
metaDescription: "This is a gatsby theme for documentation"
55
---
66

7-
import { Flex, Button } from "@commitd/components";
7+
import { Flex, Button } from "@committed/components";
88
import { navigate } from "gatsby";
99

10-
# @commitd/gatsby-theme-docs
10+
# @committed/gatsby-theme-docs
1111

1212
The gatsby theme allows you to write documentation in Markdown. With support for:
1313

1414
- :zap: MDX
1515
- :camera: images
1616
- :pencil2: svg
1717
- :tropical_fish: mermaid diagrams
18-
- :package: @commitd/components
18+
- :package: @committed/components
1919
- :tada: :shortcode: emoji.
2020

2121
This is meant for Committed's documentation site, but feel free to use it, or copy it, for your own projects.

‎example/docs/instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ metaDescription: "Instructions to create documentation using Committed docs-them
1212
Write your documentation in [Markdown](https://www.markdownguide.org/) or [MDX](https://mdxjs.com/) in the `docs` folder. Add the dependencies
1313

1414
```bash
15-
yarn add @commitd/gatsby-theme-docs gatsby react react-dom
15+
yarn add @committed/gatsby-theme-docs gatsby react react-dom
1616
```
1717

1818
and configure in `gatsby-config.js` with your site metadata e.g.
@@ -27,7 +27,7 @@ module.exports = {
2727
},
2828
plugins: [
2929
{
30-
resolve: `@commitd/gatsby-theme-docs`,
30+
resolve: `@committed/gatsby-theme-docs`,
3131
options: {}
3232
}
3333
]
@@ -69,7 +69,7 @@ module.exports = {
6969
},
7070
plugins: [
7171
{
72-
resolve: `@commitd/docs-theme`,
72+
resolve: `@committed/docs-theme`,
7373
options: {
7474
// docsPath defaults to `/docs`
7575
docsPath: "documents",

‎example/docs/mdTest.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,15 @@ Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi p
147147
Paragraph:
148148

149149
```bash
150-
git add @commitd/gatsby-theme-docs
150+
git add @committed/gatsby-theme-docs
151151
```
152152

153153
<!-- -->
154154

155155
Paragraph:
156156

157157
```bash
158-
git add @commitd/gatsby-theme-docs
158+
git add @committed/gatsby-theme-docs
159159
```
160160

161161
* * *
@@ -194,23 +194,25 @@ This is [an example][id] reference-style link.
194194

195195
[id]: http://example.com "Optional Title"
196196

197-
*single asterisks*
197+
This is *single asterisks* text
198198

199-
_single underscores_
199+
This is _single underscores_ text
200200

201-
**double asterisks**
201+
This is **double asterisks** text
202202

203-
**double underscores**
203+
This is **double underscores** text
204204

205-
~~double strike~~
205+
This is ~~double strike~~ text
206206

207-
*single asterisks*
207+
This is *single asterisks* text
208208

209-
_single underscores_
209+
This is _single underscores_ text
210210

211-
**double asterisks**
211+
This is **double asterisks** text
212212

213-
__double underscores__
213+
This is __double underscores__ text
214+
215+
This is ~~double strike~~ text
214216

215217
This paragraph has some `code` in it.
216218

‎example/gatsby-config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = {
1414
},
1515
plugins: [
1616
{
17-
resolve: `@commitd/gatsby-theme-docs`,
17+
resolve: `@committed/gatsby-theme-docs`,
1818
options: {
1919
contentPath: "docs",
2020
pathPrefix: pathPrefix(NODE_ENV),
@@ -35,7 +35,7 @@ module.exports = {
3535
{
3636
resolve: `gatsby-plugin-manifest`,
3737
options: {
38-
name: `@commitd/docs-theme`,
38+
name: `@committed/docs-theme`,
3939
short_name: `docs`,
4040
start_url: `/`,
4141
background_color: `#3E3E3E`,

‎example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"deploy": "gh-pages -d public -r https://[email protected]/commitd/docs.git"
1414
},
1515
"dependencies": {
16-
"@commitd/gatsby-theme-docs": "1.0.1",
16+
"@committed/gatsby-theme-docs": "1.0.0",
1717
"gatsby": "^2.17.6",
1818
"gatsby-plugin-manifest": "^2.2.26",
1919
"react": "^16.11.0",

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@commitd/gatsby-theme-docs-workspace",
2+
"name": "@committed/gatsby-theme-docs-workspace",
33
"private": true,
44
"version": "1.0.0",
55
"main": "index.js",

‎theme/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@commitd/gatsby-theme-docs",
3-
"version": "1.0.1",
2+
"name": "@committed/gatsby-theme-docs",
3+
"version": "1.0.0",
44
"main": "index.js",
55
"author": "Committed <[email protected]>",
66
"license": "MIT",
@@ -30,8 +30,8 @@
3030
"react-dom": "^16.11.0"
3131
},
3232
"dependencies": {
33-
"@commitd/components": "^0.0.23",
34-
"@commitd/layout": "^0.0.4",
33+
"@committed/components": "^1.0.0",
34+
"@committed/layout": "^1.0.0",
3535
"@material-ui/core": "^4.6.0",
3636
"@material-ui/icons": "^4.5.1",
3737
"@mdx-js/mdx": "^1.5.1",

‎theme/src/components/Header.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react'
22
import { useStaticQuery, graphql } from 'gatsby'
33
import { ClearLink } from './Link'
4-
import { Box, Flex, Logo, Button, Heading, Icons } from '@commitd/components'
4+
import { Box, Flex, Logo, Button, Heading, Icons } from '@committed/components'
55

66
export const Header = () => {
77
const {

‎theme/src/components/Layout.tsx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import { PreviousNext } from './PreviousNext'
88
import { SEO, SEOProps } from './SEO'
99
import { useStaticQuery, graphql } from 'gatsby'
1010
import { calculateTreeData, flattenTree } from '../util/tree'
11-
import { Root, Header as LayoutHeader, Nav, Content } from '@commitd/layout'
12-
import { ThemeProvider, CodeStyle, Container } from '@commitd/components'
11+
import { Root, Header as LayoutHeader, Nav, Content } from '@committed/layout'
12+
import { ThemeProvider, CodeStyle, Container, Box } from '@committed/components'
1313

1414
export interface LayoutProps extends SEOProps {}
1515

@@ -87,14 +87,16 @@ export const Layout = ({ children, location, title, ...props }) => {
8787
</Nav>
8888
<Content>
8989
<Container maxWidth="md">
90-
<CodeStyle>
91-
<main>{children}</main>
92-
</CodeStyle>
93-
<PreviousNext
94-
prefix={prefix}
95-
data={flattenedData}
96-
location={location}
97-
/>
90+
<Box py={3}>
91+
<CodeStyle>
92+
<main>{children}</main>
93+
</CodeStyle>
94+
<PreviousNext
95+
prefix={prefix}
96+
data={flattenedData}
97+
location={location}
98+
/>
99+
</Box>
98100
</Container>
99101
</Content>
100102
<Footer />

‎theme/src/components/Link.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
22
import { navigate } from 'gatsby'
3-
import { Link as RawLink, LinkProps } from '@commitd/components'
3+
import { Link as RawLink, LinkProps } from '@committed/components'
44

55
const isExternal = (url: string) => url && url.startsWith('http')
66
const isInPage = (url: string) => url && url.startsWith('#')

‎theme/src/components/Markdown.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React, { FC } from 'react'
22
import { MDXProvider } from '@mdx-js/react'
33
import MDXRenderer from 'gatsby-plugin-mdx/mdx-renderer'
44
import { Link } from './Link'
5-
import { mdx } from '@commitd/components'
5+
import { mdx } from '@committed/components'
66

77
interface MardownProps {
88
children: any

‎theme/src/components/PreviousNext.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react'
22
import { Info } from '../types'
33
import { navigate } from 'gatsby'
4-
import { Flex, Button, Divider, Icons } from '@commitd/components'
4+
import { Flex, Button, Divider, Icons } from '@committed/components'
55

66
export interface PreviousNextProps {
77
prefix: string

‎theme/src/components/Sidebar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
List,
99
ListItem,
1010
ListItemText
11-
} from '@commitd/components'
11+
} from '@committed/components'
1212

1313
export interface SidebarProps {
1414
prefix: string

‎theme/src/components/Tree.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React, { useState } from 'react'
22
import { Node } from '../types'
33
import TreeNode from './TreeNode'
44
import { navigate } from 'gatsby'
5-
import { List } from '@commitd/components'
5+
import { List } from '@committed/components'
66

77
export interface TreeProps {
88
location?: any

‎theme/src/components/TreeNode.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
ListItem,
99
ListItemText,
1010
Collapse
11-
} from '@commitd/components'
11+
} from '@committed/components'
1212

1313
export interface TreeNodeProps extends Item {
1414
isActive: (key: string) => boolean

‎theme/src/pages/404.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
22
import { Layout } from '../components/Layout'
3-
import { Display, Text, Box, Loader } from '@commitd/components'
3+
import { Display, Text, Box, Loader } from '@committed/components'
44

55
const NotFoundPage = () => (
66
<Layout title="404: Not found">

‎yarn.lock

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -824,17 +824,17 @@
824824
resolved "https://registry.yarnpkg.com/@braintree/sanitize-url/-/sanitize-url-3.1.0.tgz#8ff71d51053cd5ee4981e5a501d80a536244f7fd"
825825
integrity sha512-GcIY79elgB+azP74j8vqkiXz8xLFfIzbQJdlwOPisgbKT00tviJQuEghOXSMVxJ00HoYJbGswr4kcllUc4xCcg==
826826

827-
"@commitd/components@^0.0.23":
828-
version "0.0.23"
829-
resolved "https://registry.yarnpkg.com/@commitd/components/-/components-0.0.23.tgz#89f785d59b77207a8e82f5bc4c9a492545ba3140"
830-
integrity sha512-ZffCcWQyFpPPKGkkro4W22lCtaPD6Z9SE5/Vk77qQdNy3isExAHfoAwRBqzdd1aBy3JifFAK1Z5sgQ2r8DgjwA==
827+
"@committed/components@^1.0.0":
828+
version "1.0.0"
829+
resolved "https://registry.yarnpkg.com/@committed/components/-/components-1.0.0.tgz#3748b7f94d6c1b6db9cfea3df409e5ed782788f4"
830+
integrity sha512-GNejpQ4Y2bNOZep1iUrMQQcnciE8Aw9CZo2pJdGvatKIns24VWsG0H4LMzdlUaAEK7lg6xLbVd5/fyyZ6ddh8w==
831831
dependencies:
832832
clsx "^1.0.4"
833833

834-
"@commitd/layout@^0.0.4":
835-
version "0.0.4"
836-
resolved "https://registry.yarnpkg.com/@commitd/layout/-/layout-0.0.4.tgz#6ad85fae7b2e4fb6cbc8bb1fd7fd5183f9479473"
837-
integrity sha512-QpFEr2m5mPu1f0YsRx28PLBNbj6F5xlaUFqiMV5OEnRXWD+oWitzko5uL9LE1PXosbEGwuKiY7j8s+bmQ9koEw==
834+
"@committed/layout@^1.0.0":
835+
version "1.0.0"
836+
resolved "https://registry.yarnpkg.com/@committed/layout/-/layout-1.0.0.tgz#10db46a6304719fc5a698be44666cd5e3e85d5f7"
837+
integrity sha512-ivdReS0FByiEPOvCdfKQpEwZI2zuJzE61Dj/LoLcuLYHmGPGiUzKvGVPKZe4MbWpyGocfofkaKy+iwTRYwVuTQ==
838838

839839
"@emotion/hash@^0.7.1":
840840
version "0.7.3"

0 commit comments

Comments
 (0)