@@ -16,9 +16,9 @@ contribute a change? Great!
16
16
17
17
## Quick start
18
18
19
- 1 . ` npm install ` to download gatsby , our theme, and the dependencies
19
+ 1 . ` npm install ` to download Gatsby , our theme, and the dependencies
20
20
2 . ` npm run develop ` : starts the test server at ` http://localhost:8000 ` .
21
- 3 . Update the content - it's Mdx , which is like markdown - in the ` content `
21
+ 3 . Update the content - it's MDX , which is like markdown - in the ` content `
22
22
directory.
23
23
4 . Review your content at ` http://localhost:8000 ` . (Gatsby watches the
24
24
filesystem and will reload your content changes immediately.)
@@ -30,10 +30,10 @@ contribute a change? Great!
30
30
31
31
## Running locally
32
32
33
- First, ` npm install ` the dependencies. This will install gatsby , et al.
33
+ First, ` npm install ` the dependencies. This will install Gatsby , et al.
34
34
35
35
Next, ` npm run develop ` to start the test server to view your changes.
36
- The gatsby server will be started on port 8000. You can navigate to
36
+ The Gatsby server will be started on port 8000. You can navigate to
37
37
` http://localhost:8000 ` to view the site live.
38
38
39
39
** For best results use npm 8**
@@ -46,7 +46,7 @@ changes you make should be reflected in the site immediately.
46
46
### Documentation content
47
47
48
48
The documentation content lives in the ` content ` directory, and is
49
- markdown. (Actually, [ Mdx ] ( https://mdxjs.com/ ) , a sort of reactive
49
+ markdown. (Actually, [ MDX ] ( https://mdxjs.com/ ) , a sort of reactive
50
50
markdown.)
51
51
52
52
### Static content (images)
@@ -55,7 +55,7 @@ Static content lives in the `static` directory. Since most of the
55
55
static content is screenshots, you can use the ` Screenshot ` component
56
56
to reference them, which is an extension of the ` Img ` component that
57
57
is configured for the docs site. For example, an image living as
58
- ` static/organizations/managing-temas /team-members.png ` would be
58
+ ` static/organizations/managing-teams /team-members.png ` would be
59
59
referenced as:
60
60
61
61
```
@@ -69,7 +69,7 @@ referenced as:
69
69
There are various places where we want to share content between
70
70
pages, to prevent copy-pasta. For example, we display a screenshot
71
71
of the user login dialog repeatedly. Therefore this shared content
72
- is defined in ` src/shared.js ` , and includes a literal Mdx snippet.
72
+ is defined in ` src/shared.js ` , and includes a literal MDX snippet.
73
73
74
74
For example, ` user-login ` is defined with ` text ` and ` image `
75
75
properties:
@@ -83,7 +83,7 @@ m login dialog" />)
83
83
},
84
84
```
85
85
86
- Since Mdx is reactive, you can import the shared data at the top of the
86
+ Since MDX is reactive, you can import the shared data at the top of the
87
87
file, just beneath your frontmatter:
88
88
89
89
```
@@ -222,7 +222,7 @@ On step three, your changes will be published live! 🎉
222
222
223
223
## Theme
224
224
225
- The gatsby theme used here is located in the [ ` theme/ ` ] ( ./theme ) directory. It is a variation of
225
+ The Gatsby theme used here is located in the [ ` theme/ ` ] ( ./theme ) directory. It is a variation of
226
226
[ doctocat] ( https://github.com/primer/doctocat ) with some theme changes
227
227
for npm's design language and additional components to support multiple
228
- versions of the CLI documentation.
228
+ versions of the CLI documentation.
0 commit comments