Skip to content

Commit 2cb8d33

Browse files
committed
Format
1 parent c1c430f commit 2cb8d33

File tree

16 files changed

+95
-90
lines changed

16 files changed

+95
-90
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Set up Node
1919
uses: actions/setup-node@v1
2020
with:
21-
node-version: "16"
21+
node-version: '16'
2222
- uses: actions/cache@v2
2323
with:
2424
path: ~/.npm

.github/workflows/pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Set up Node
1717
uses: actions/setup-node@v1
1818
with:
19-
node-version: "16"
19+
node-version: '16'
2020
- uses: actions/cache@v2
2121
with:
2222
path: ~/.npm

.vscode/settings.json

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

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@ and configure in `gatsby-config.js` with your site metadata e.g.
4545
```javascript
4646
module.exports = {
4747
siteMetadata: {
48-
title: "Title",
49-
author: "Author",
50-
description: "Description",
51-
siteUrl: "https://your.site.url",
48+
title: 'Title',
49+
author: 'Author',
50+
description: 'Description',
51+
siteUrl: 'https://your.site.url',
5252
},
5353
plugins: [
5454
{
5555
resolve: `@committed/gatsby-theme-docs`,
5656
options: {},
5757
},
5858
],
59-
};
59+
}
6060
```
6161

6262
Put your markdown docs in `/docs/` and run:

example/docs/example1.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Example md"
3-
order: "1"
4-
metaTitle: "Example Markdown"
5-
metaDescription: "This is an example of markdown docs"
2+
title: 'Example md'
3+
order: '1'
4+
metaTitle: 'Example Markdown'
5+
metaDescription: 'This is an example of markdown docs'
66
---
77

88
# (H1) Example Markdown
@@ -16,7 +16,7 @@ Some examples are below.
1616
The following is a code block with JavaScript language syntax highlighting by [prism](https://prismjs.com/).
1717

1818
```javascript
19-
import React from "react";
19+
import React from 'react'
2020
```
2121

2222
### (H3) Links
@@ -37,11 +37,11 @@ If in a folder you can use relative links so to link from page `example/1.md` to
3737
3838
##### (H5) Images
3939

40-
Images (PNG and JPEG) ![Example Image](./CommittedSoftware.png "Committed Software")
40+
Images (PNG and JPEG) ![Example Image](./CommittedSoftware.png 'Committed Software')
4141

4242
SVG
4343

44-
![Example Image](./CommittedSoftware.svg "Committed Software")
44+
![Example Image](./CommittedSoftware.svg 'Committed Software')
4545

4646
###### (H6) Lists
4747

example/docs/example2.mdx

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Example mdx"
3-
order: "2"
4-
metaTitle: "This is meta title"
5-
metaDescription: "This is the meta description"
2+
title: 'Example mdx'
3+
order: '2'
4+
metaTitle: 'This is meta title'
5+
metaDescription: 'This is the meta description'
66
---
77

8-
import React from "react"
9-
8+
import React from 'react'
109

1110
# Example MDX
1211

@@ -18,28 +17,35 @@ Elements can use state:
1817

1918
<Card my={3}>
2019
<CardContent>
21-
{React.createElement(() => {
22-
const [open, setOpen] = React.useState(false)
23-
return (
24-
<>
25-
<FormControl component="fieldset">
26-
<FormLabel component="legend">Example</FormLabel>
27-
<FormGroup aria-label="position" row>
28-
<FormControlLabel
29-
control={<Checkbox checked={open} onChange={() => setOpen(!open)} color="primary" />}
30-
label="Open"
31-
labelPlacement="end"
32-
onChange={() => setOpen()}
33-
/>
34-
</FormGroup>
35-
</FormControl>
36-
<Collapse in={open}>
37-
<Box p={4}>
38-
<Loader color="primary" variant={'spin'} size={100}/>
39-
</Box>
40-
</Collapse>
41-
</>
42-
)})}
20+
{React.createElement(() => {
21+
const [open, setOpen] = React.useState(false)
22+
return (
23+
<>
24+
<FormControl component="fieldset">
25+
<FormLabel component="legend">Example</FormLabel>
26+
<FormGroup aria-label="position" row>
27+
<FormControlLabel
28+
control={
29+
<Checkbox
30+
checked={open}
31+
onChange={() => setOpen(!open)}
32+
color="primary"
33+
/>
34+
}
35+
label="Open"
36+
labelPlacement="end"
37+
onChange={() => setOpen()}
38+
/>
39+
</FormGroup>
40+
</FormControl>
41+
<Collapse in={open}>
42+
<Box p={4}>
43+
<Loader color="primary" variant={'spin'} size={100} />
44+
</Box>
45+
</Collapse>
46+
</>
47+
)
48+
})}
4349
</CardContent>
4450
</Card>
4551

example/docs/example3.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Example mermaid"
3-
order: "3"
2+
title: 'Example mermaid'
3+
order: '3'
44
---
55

66
# Example Mermaid

example/docs/index.mdx

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

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

1010
# @committed/gatsby-theme-docs
1111

@@ -26,7 +26,7 @@ This is meant for Committed's documentation site, but feel free to use it, or co
2626
my={3}
2727
size="large"
2828
color="primary"
29-
onClick={() => navigate("/instructions")}
29+
onClick={() => navigate('/instructions')}
3030
>
3131
Get Started
3232
</Button>

example/docs/instructions.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Instructions"
3-
order: "0"
4-
metaTitle: "Instructions"
5-
metaDescription: "Instructions to create documentation using Committed docs-theme"
2+
title: 'Instructions'
3+
order: '0'
4+
metaTitle: 'Instructions'
5+
metaDescription: 'Instructions to create documentation using Committed docs-theme'
66
---
77

88
# Instructions
@@ -24,18 +24,18 @@ and configure in `gatsby-config.js` with your site metadata e.g.
2424
```javascript
2525
module.exports = {
2626
siteMetadata: {
27-
title: "Title",
28-
author: "Author",
29-
description: "Description",
30-
siteUrl: "https://your.site.url",
27+
title: 'Title',
28+
author: 'Author',
29+
description: 'Description',
30+
siteUrl: 'https://your.site.url',
3131
},
3232
plugins: [
3333
{
3434
resolve: `@committed/gatsby-theme-docs`,
3535
options: {},
3636
},
3737
],
38-
};
38+
}
3939
```
4040

4141
Further options are available to customize, detailed below.

example/docs/nested/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
order: "4"
2+
order: '4'
33
---
44

55
# Nested

0 commit comments

Comments
 (0)