Skip to content

Commit 6e7b186

Browse files
chore(docs): check titles, headlines & text + change some NOTE… (#18654)
* check titles, headlines & text + change some NOTE ot Note * trigger circleCi * remove blank line in docs/mdx/getting-started & trigger circleCI * reverting one change * typo Co-authored-by: Lennart <[email protected]>
1 parent fef8e7e commit 6e7b186

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

docs/docs/mdx/markdown-syntax.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ How unordered lists are rendered in HTML:
9292
1. Two
9393
1. Three
9494

95-
## Links and Images
95+
## Links and images
9696

9797
### Link
9898

@@ -145,14 +145,14 @@ This pattern is appropriate for [decorative or repetitive images](https://www.w3
145145
>
146146
> more quotes
147147
148-
## Code Comments
148+
## Code comments
149149

150150
### Inline
151151

152152
- Enclose the text in backticks \`code\`
153153
- Inline `code` looks like this sentence
154154

155-
### Code Blocks
155+
### Code blocks
156156

157157
- Indent a block by four spaces
158158

@@ -180,7 +180,7 @@ This pattern is appropriate for [decorative or repetitive images](https://www.w3
180180
---
181181
```
182182

183-
## Frontmatter + MDX Example
183+
## Frontmatter + MDX example
184184

185185
```
186186
---
@@ -196,7 +196,7 @@ The chart is rendered inside our MDX document.
196196
<Chart description={description} />
197197
```
198198

199-
## Helpful Resources
199+
## Helpful resources
200200

201201
- https://daringfireball.net/projects/markdown/syntax
202202
- https://www.markdownguide.org/basic-syntax

docs/docs/mdx/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ by Gatsby image processing.
5858
![my image](./my-awesome-image.png)
5959
```
6060

61-
## remark plugins
61+
## Remark plugins
6262

6363
You can use [remark plugins](https://github.com/remarkjs/remark/blob/master/doc/plugins.md)
6464
directly if there are transformations you'd like to make on your

docs/docs/mdx/programmatically-creating-pages.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You'll need to use `gatsby-source-filesystem` and tell it to source
2222
"posts" from a folder called `content/posts` located in the project's
2323
root.
2424

25-
> **NOTE**: `gatsby-plugin-mdx` uses `.mdx` by default as a file extension to
25+
> **Note**: `gatsby-plugin-mdx` uses `.mdx` by default as a file extension to
2626
> recognize which files to use. You can also [use `.md` as a file
2727
> extension](/packages/gatsby-plugin-mdx#extensions) if you want.
2828
@@ -49,7 +49,7 @@ You can read about
4949
[`gatsby-source-filesystem`](/packages/gatsby-source-filesystem)
5050
if you'd like to learn more.
5151

52-
## Add MDX Files
52+
## Add MDX files
5353

5454
Before you can write any GraphQL queries and programmatically create
5555
pages, you need to add some content.
@@ -64,28 +64,28 @@ mkdir -p content/posts
6464
touch content/posts/blog-{1,2}.mdx
6565
```
6666

67-
> **NOTE**:
67+
> **Note**:
6868
> `mkdir -p path/to/a/directory` will create every folder in the path if
6969
> it does not exist.
7070
>
71-
> _`touch <filename>` will create an empty file named `<filename>`. The
71+
> `touch <filename>` will create an empty file named `<filename>`. The
7272
> brackets (`{}`) are [an
7373
> expansion](https://twitter.com/kentcdodds/status/1083399683932868609?s=19)
74-
> which means you can create multiple files in one command._
74+
> which means you can create multiple files in one command.
7575
7676
Open up each of the files you just created and add some content.
7777

7878
```md:title=blog-1.mdx
7979
---
80-
title: "Blog Post 1"
80+
title: Blog Post 1
8181
---
8282

8383
Trying out MDX
8484
```
8585

8686
```md:title=blog-2.mdx
8787
---
88-
title: "Blog Post 2"
88+
title: Blog Post 2
8989
---
9090

9191
Gatsby is the best
@@ -138,15 +138,15 @@ paths to usable URLs.
138138

139139
[`onCreateNode`](https://www.gatsbyjs.org/docs/node-apis/#onCreateNode)
140140
is a Gatsby lifecycle method that gets called whenever a new node is
141-
created. In this case only `Mdx` nodes are touched.
141+
created. In this case only `MDX` nodes are touched.
142142

143143
## Create pages from sourced MDX files
144144

145145
In order to create pages from the sourced MDX files, you need
146146
to construct a query that finds all MDX nodes and pulls out
147147
the `slug` field added earlier.
148148

149-
> **NOTE**: You can open up a GraphiQL console for query testing
149+
> **Note**: You can open up a GraphiQL console for query testing
150150
> in your browser at <http://localhost:8000/___graphql>
151151
152152
```graphql
@@ -219,7 +219,7 @@ API.
219219

220220
## Make a template for your posts
221221

222-
Make a file called `posts-page-layout.js` in `src/components`. This component
222+
You can create a file called `posts-page-layout.js` in `src/components` - this component
223223
will be rendered as the template for all posts. There's a component,
224224
`MDXRenderer` which is used by `gatsby-plugin-mdx` that will be used to render any
225225
programmatically accessed MDX content.
@@ -294,10 +294,10 @@ That's it, you're done. Run `gatsby develop` and enjoy your new MDX
294294
powers.
295295

296296
Now you have all the pieces you need to programmatically create pages
297-
with Gatsby and `gatsby-plugin-mdx`. Check out our other guides to find out
297+
with Gatsby and `gatsby-plugin-mdx`. You can check out our other guides to find out
298298
more about all of the cool stuff you can do with `gatsby-plugin-mdx`.
299299

300-
## Bonus: Make a Blog Index
300+
## Bonus: Make a blog index
301301

302302
```javascript:title=src/pages/index.js
303303
import React from "react"

docs/docs/mdx/writing-pages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ query {
4646
}
4747
```
4848

49-
> **Note:** To query `Mdx` content, it must be included in the node system using a
49+
> **Note:** To query `MDX` content, it must be included in the node system using a
5050
> source like the `gatsby-source-filesystem` plugin first. Instructions for sourcing
5151
> content from somewhere like your `/src/pages` directory can be found on the [plugin's README](/packages/gatsby-source-filesystem/).
5252
@@ -94,12 +94,12 @@ file might look something like this:
9494

9595
### Why Gatsby?
9696

97-
Gatsby delivers faster, more secure sites and apps from a variety of data
97+
Gatsby delivers faster, more secure sites and apps from a variety of data
9898
sources
9999

100100
### Where do I start?
101101

102-
The documentation offers guides for all different skill levels, you can
102+
The documentation offers guides for all different skill levels, you can
103103
find more info at the Gatsby's [Quick Start page](https://www.gatsbyjs.org/docs/quick-start)
104104

105105
<!-- This default export overrides the default layout ensuring -->
@@ -152,7 +152,7 @@ export const metadata = {
152152
path: "/world",
153153
};
154154

155-
# Hello, <span children={metadata.name} />
155+
# Hello, <span children={metadata.name} />
156156

157157
The span above will read: "Hello, World".
158158

@@ -210,7 +210,7 @@ const PurpleBorder = ({ children }) => (
210210
export default PurpleBorder
211211
```
212212

213-
## GraphQL Queries
213+
## GraphQL queries
214214

215215
You can fetch data to use in your MDX file by exporting a `pageQuery`
216216
in the same way you would for a `.js` page. The queried data is passed

0 commit comments

Comments
 (0)