Skip to content

Commit 36deb50

Browse files
authored
Fix sentences running together
Closes GH-1414 Reviewed-by: Christian Murphy <[email protected]>
1 parent f5a5256 commit 36deb50

24 files changed

+84
-84
lines changed

docs/404.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# 404
22

3-
Page not found.[Return Home](/)
3+
Page not found. [Return Home](/)

docs/about.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# About
22

33
MDX is based on the [original `.mdx` proposal][idea] by Guillermo Rauch
4-
([@rauchg][rauchg]).Its syntax is defined by an official [specification][].
4+
([@rauchg][rauchg]). Its syntax is defined by an official [specification][].
55
The source code for MDX is available on [GitHub][] and is [MIT licensed][license].
66

77
The project is governed by the [unified collective][governance].

docs/advanced/components.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ documents via the [MDXProvider](#mdxprovider).
5151
### Layout props
5252

5353
You’ll also notice that `layoutProps` is created based on your exports
54-
and then passed to the wrapper.This allows for the wrapper to use
54+
and then passed to the wrapper. This allows for the wrapper to use
5555
those props automatically for handling things like adding an author
5656
bio to the wrapped document.
5757

5858
## `makeShortcode`
5959

6060
There is one other function added to the compiled output: `makeShortcode`.
61-
This is added for [shortcode support](/blog/shortcodes).It’s used in order
61+
This is added for [shortcode support](/blog/shortcodes). It’s used in order
6262
to stub any components that aren’t directly imported so that there won’t be
6363
any `ReferenceError`s. If they’re passed to the `MDXProvider`, the custom
6464
JSX pragma will pull the component from context and use that in place of the
@@ -102,9 +102,9 @@ export default () => (
102102
### Caveats
103103

104104
Because MDXProvider uses React Context directly, it is affected by
105-
the same caveats.It is therefore important that you do not declare
106-
your components mapping inline in the JSX.Doing so will trigger a rerender
107-
of your entire MDX page with every render cycle.Not only is this bad for
105+
the same caveats. It is therefore important that you do not declare
106+
your components mapping inline in the JSX. Doing so will trigger a rerender
107+
of your entire MDX page with every render cycle. Not only is this bad for
108108
performance, but it can cause unwanted side affects, like breaking in-page
109109
browser navigation.
110110

docs/advanced/transform-content.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ are many utilities you can use to work with MDX.
66

77
You can utilize [to-vfile][] to read and write MDX files
88
and you can leverage [remark][] and [remark-mdx][]
9-
to parse and process MDX content.The remark-mdx library is a parsing
9+
to parse and process MDX content. The remark-mdx library is a parsing
1010
extension to enhance the Markdown [AST][] to understand MDX
1111
(resulting in [MDXAST][]), giving you access and insight to MDX
1212
attributes, namely imports, exports, and jsx.

docs/blog/custom-pragma.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
`MDXTag`, for those that aren’t aware, is a critical piece in the way
66
MDX replaces HTML primitives like `<pre>` and `<h1>` with custom React
7-
Components.[I’ve previously
7+
Components. [I’ve previously
88
written](https://www.christopherbiscardi.com/post/codeblocks-mdx-and-mdx-utils)
99
about the way `MDXTag` works when trying to replace the `<pre>` tag
1010
with a custom code component.
@@ -39,7 +39,7 @@ exports.preToCodeBlock = preProps => {
3939
```
4040

4141
So `MDXTag` is a real Component in the middle of all of the other MDX
42-
rendered elements.All of the code is included here for reference.
42+
rendered elements. All of the code is included here for reference.
4343

4444
```js
4545
import React, {Component} from 'react'
@@ -86,7 +86,7 @@ export default withMDXComponents(MDXTag)
8686

8787
`MDXTag` is used in the [mdx-hast-to-jsx
8888
conversion](https://github.com/mdx-js/mdx/blob/e1bcf1b1a352c9728424b01c1bb5d62e450eb48d/packages/mdx/mdx-hast-to-jsx.js#L163-L165),
89-
which is the final step in the MDX AST pipeline.Every renderable
89+
which is the final step in the MDX AST pipeline. Every renderable
9090
element is wrapped in an `MDXTag`, and `MDXTag` handles rendering the
9191
element later.
9292

@@ -171,12 +171,12 @@ wrapping `MDXTag`.
171171

172172
Now that we’ve cleaned up the intermediary representation, we need to
173173
make sure that we have the same functionality as the old
174-
`MDXTag`.This is done through a custom `createElement`
175-
implementation.Typically when using React, we use
176-
`React.createElement` to render the elements on screen.This is even
174+
`MDXTag`. This is done through a custom `createElement`
175+
implementation. Typically when using React, we use
176+
`React.createElement` to render the elements on screen. This is even
177177
true if you’re using JSX because JSX tags such as `<div>` compile to
178-
`createElement` calls.So this time instead of using
179-
`React.createElement` we’ll be using our own.[Check it out in the MDX
178+
`createElement` calls. So this time instead of using
179+
`React.createElement` we’ll be using our own. [Check it out in the MDX
180180
repo](https://github.com/mdx-js/mdx/blob/0506708bed0ac787f605b0a97ef77d1954fa1275/packages/react/src/create-element.js)
181181

182182
Reproduced here is our `createElement` function and the logic for how
@@ -220,7 +220,7 @@ export default function (type, props) {
220220

221221
One really cool application of the new output format using a custom
222222
`createElement` is that we can now write versions of it for Vue and
223-
other frameworks.Since the pragma insertion is the responsibility of
223+
other frameworks. Since the pragma insertion is the responsibility of
224224
the webpack (or other bundlers) loader, swapping the pragma can be an
225225
option in mdx-loader as long as we have a Vue `createElement` to point
226226
to.

docs/blog/shortcodes.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import {Button} from '@rebass/emotion'
44

55
# Shortcodes
66

7-
An exciting new feature in MDX v1 is global shortcodes.This
7+
An exciting new feature in MDX v1 is global shortcodes. This
88
allows you to expose components to all of your documents in
9-
your app or website.This is a useful feature for common
9+
your app or website. This is a useful feature for common
1010
components like YouTube embeds, Twitter cards, or anything
1111
else frequently used in your documents.
1212

@@ -27,7 +27,7 @@ export default ({children}) => (
2727
```
2828

2929
Then, any MDX document that’s wrapped in `App` has access to
30-
`YouTube`, `Twitter`, and `TomatoBox`.Shortcodes are nothing
30+
`YouTube`, `Twitter`, and `TomatoBox`. Shortcodes are nothing
3131
more than components, so you can reference them anywhere in an
3232
MDX document with JSX.
3333

docs/blog/v1.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
# MDX goes stable
77

88
It’s been a year and a half since the first MDX commit and a year since MDX was first announced at
9-
ZEIT Day.MDX is a radical paradigm shift in how to write immersive content using components.It’s
9+
ZEIT Day. MDX is a radical paradigm shift in how to write immersive content using components. It’s
1010
an open, [authorable format](https://johno.com/authorable-format) that makes it _fun_ to write again.
1111

1212
Since announcing MDX we’ve been working on numerous bug fixes, new features, better parsing, and integration
13-
tests.Now, we think it’s ready.**We’re happy to finally release v1!**
13+
tests. Now, we think it’s ready. **We’re happy to finally release v1!**
1414

1515
## 🎉 What’s new?
1616

@@ -26,11 +26,11 @@ Please open an issue if you find a case we haven’t covered!😸
2626

2727
### remark-mdx
2828

29-
`remark-mdx` is the syntactic extension for MDX in remark.It provides the parsing functionality for
30-
MDX as a _[remark](https://github.com/remarkjs/remark) plugin_.That sounds a bit meta.What it means
29+
`remark-mdx` is the syntactic extension for MDX in remark. It provides the parsing functionality for
30+
MDX as a _[remark](https://github.com/remarkjs/remark) plugin_. That sounds a bit meta. What it means
3131
is that before we had the syntax parsing bits _in_ the library (unusable from the outside), and now it’s
32-
externalized (usable from the outside).This is useful if you want to inspect or transform MDX documents.
33-
For example, it allows tools like prettier to use the exact same parser used by MDX core.Or you could
32+
externalized (usable from the outside). This is useful if you want to inspect or transform MDX documents.
33+
For example, it allows tools like prettier to use the exact same parser used by MDX core. Or you could
3434
use `remark-mdx` in combination with [remark-lint](https://github.com/remarkjs/remark-lint) to check your
3535
MDX.
3636

@@ -61,9 +61,9 @@ improving the docs and updating the build tooling.
6161

6262
## Breaking changes
6363

64-
In order to make some improvements we were forced to introduce a few breaking changes.**These were the
65-
result of real-world production testing and feedback**.The community has evolved and we’ve come up with
66-
newer, better ideas over the last year.We have made sure the impact is small and have written a full
64+
In order to make some improvements we were forced to introduce a few breaking changes. **These were the
65+
result of real-world production testing and feedback**. The community has evolved and we’ve come up with
66+
newer, better ideas over the last year. We have made sure the impact is small and have written a full
6767
migration guide.
6868

6969
- 🚨`@mdx-js/tag` is replaced by `@mdx-js/react` and an `@mdx` pragma - [migration guide](/migrating/v1#pragma)
@@ -74,14 +74,14 @@ migration guide.
7474

7575
#### Deprecations
7676

77-
We only needed to introduce one deprecation.The `mdPlugins` and `hastPlugins` options have been renamed
78-
`remarkPlugins` and `rehypePlugins` respectively.For the time being we will issue a warning when the old options
79-
are used.In v2, the old options will be removed.
77+
We only needed to introduce one deprecation. The `mdPlugins` and `hastPlugins` options have been renamed
78+
`remarkPlugins` and `rehypePlugins` respectively. For the time being we will issue a warning when the old options
79+
are used. In v2, the old options will be removed.
8080

8181
## 📈 Growth
8282

8383
A major release is always a good time to take a step back and reflect on what’s been happening in terms of growth
84-
and the greater community.The ecosystem surrounding MDX has already grown larger than we ever dreamed.We’ve also
84+
and the greater community. The ecosystem surrounding MDX has already grown larger than we ever dreamed.We’ve also
8585
seen projects/products/application we never even imagined.
8686

8787
### Numbers
@@ -93,7 +93,7 @@ seen projects/products/application we never even imagined.
9393
- **Commits**: 670
9494

9595
The contributor growth is one of the most important aspects here as we have numerous community members that are familiar
96-
with MDX internals.This allows us to continually improve the project and spread the workload against an ever growing
96+
with MDX internals. This allows us to continually improve the project and spread the workload against an ever growing
9797
team of contributors.
9898

9999
[See the contributor graph](https://github.com/mdx-js/mdx/graphs/contributors)
@@ -127,16 +127,16 @@ so in addition to bug fixes and parsing issues we might encounter.
127127
### Vue support
128128

129129
Supporting Vue is an important goal for MDX and is one of the primary reasons we’ve rearchitected MDX to use
130-
custom pragma.We’re delighted that **we now have an alpha version for Vue working**.We’d love it if anyone
130+
custom pragma. We’re delighted that **we now have an alpha version for Vue working**. We’d love it if anyone
131131
from the Vue community wants to give it a try and provide feedback.
132132

133133
[See the Vue example](https://github.com/mdx-js/mdx/tree/master/examples/vue)
134134

135135
### Blocks project
136136

137-
One of the key missing aspects of authoring MDX documents is the editing experience.Currently, there isn’t an
138-
approachable way to write MDX unless you enjoy working in a text editor and writing raw Markdown/code.We’d
139-
like to solve that and have begun work on an MDX “blocks editor” that’s a **content-focused WYSIWYG**.Not to mention,
137+
One of the key missing aspects of authoring MDX documents is the editing experience. Currently, there isn’t an
138+
approachable way to write MDX unless you enjoy working in a text editor and writing raw Markdown/code. We’d
139+
like to solve that and have begun work on an MDX “blocks editor” that’s a **content-focused WYSIWYG**. Not to mention,
140140
we’ll be doing all that we can to make sure the editor is as accessible as it can be from the beginning.
141141

142142
When we have a beta ready we will be open sourcing it and announcing, so stay tuned.
@@ -156,7 +156,7 @@ projects are used all over the web, and it would never be possible without finan
156156

157157
## 🙏 Thanks
158158

159-
We’d like to say thanks to all our contributors and our happy users.Special thanks to
159+
We’d like to say thanks to all our contributors and our happy users. Special thanks to
160160
[@wooorm](https://github.com/wooorm),
161161
[@silvenon](https://github.com/silvenon),
162162
[@timneutkens](https://github.com/timneutkens),

docs/contributing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ We’re always looking for more opinions on discussions in the issue tracker.
6969

7070
### Write code
7171

72-
Code contributions are very welcome.It’s often good to first create an issue
72+
Code contributions are very welcome. It’s often good to first create an issue
7373
to report a bug or suggest a new feature before creating a pull request to
7474
prevent you from doing unnecessary work.
7575

@@ -79,7 +79,7 @@ prevent you from doing unnecessary work.
7979
2. `yarn test`
8080

8181
Tests for an individual package can be run as a yarn workspace:
82-
`yarn workspace remark-mdx test`.To see what packages ar available to test
82+
`yarn workspace remark-mdx test`. To see what packages ar available to test
8383
you can list out all workspaces with `yarn workspaces info`.
8484

8585
## Running the docs site
@@ -90,7 +90,7 @@ you can list out all workspaces with `yarn workspaces info`.
9090

9191
## Submitting an issue
9292

93-
- The issue tracker is for issues.Use chat for support
93+
- The issue tracker is for issues. Use chat for support
9494
- Search the issue tracker (including closed issues) before opening a new
9595
issue
9696
- Ensure you’re using the latest version of our packages

docs/getting-started/babel-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Babel configuration
22

33
You will also need to configure [babel][] to support the language features that
4-
MDX uses.One way you can achieve that is using the following `.babelrc`
4+
MDX uses. One way you can achieve that is using the following `.babelrc`
55
at your project root.
66

77
```json

docs/getting-started/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ structures.
239239
##### Defining variables with exports
240240

241241
If you need to define a variable in your MDX document, you can use an export
242-
to do so.Not only do exports emit data, they instantiate data you can reference
242+
to do so. Not only do exports emit data, they instantiate data you can reference
243243
in JSX blocks:
244244

245245
```js

docs/getting-started/next.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To have Next.js treat `.mdx` files in the pages directory as pages use the `page
2222
```js
2323
// next.config.js
2424
const withMDX = require('@next/mdx')({
25-
extension: /\.mdx?$/,
25+
extension: /\.mdx?$/
2626
})
2727
module.exports = withMDX({
28-
pageExtensions: ['js', 'jsx', 'mdx'],
28+
pageExtensions: ['js', 'jsx', 'mdx']
2929
})
3030
```
3131

docs/getting-started/webpack.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ npm install --save-dev @mdx-js/loader
1313

1414
## Configuration
1515

16-
The loader needs to be used in tandem with the [babel-loader][].Most projects will typically
16+
The loader needs to be used in tandem with the [babel-loader][]. Most projects will typically
1717
already include this if you are using JSX syntax.
1818

1919
For webpack projects you can define the following `webpack.config.js` extension
@@ -38,8 +38,8 @@ module.exports = {
3838

3939
If you only want the loader for `.mdx` files you can change the regex to `/\.mdx$/`.
4040

41-
The transpiled output for MDX requires [babel][] to be run.This is typically
42-
by adding in the babel-loader to run _after_ the MDX loader.Webpack starts
41+
The transpiled output for MDX requires [babel][] to be run. This is typically
42+
by adding in the babel-loader to run _after_ the MDX loader. Webpack starts
4343
from the end of the loaders array and works backward, so it is important to
4444
follow the ordering above.
4545

docs/getting-started/x0.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Note from 'gatsby-theme-mdx/src/components/note'
77
caution!
88
</Note>
99

10-
[x0][] is a zero-config tool with built in support for MDX.You will need
10+
[x0][] is a zero-config tool with built in support for MDX. You will need
1111
to install the library and set up the npm script.
1212

1313
## Installation
@@ -28,8 +28,8 @@ Then, in your `package.json` add the following to the `scripts`:
2828
## Customizing the layout
2929

3030
[x0][] supports MDX files with either `.md` or `.mdx` file extensions out of
31-
the box.For components requiring providers you will need to use customize
32-
`_app.js`.Here’s an example using [Rebass][] components:
31+
the box. For components requiring providers you will need to use customize
32+
`_app.js`. Here’s an example using [Rebass][] components:
3333

3434
```jsx
3535
import React from 'react'

docs/getting-started/zero.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Note from 'gatsby-theme-mdx/src/components/note'
88
</Note>
99

1010
[Zero](https://zeroserver.io) is a no-config web framework for React, MDX,
11-
Node.js, and Vue.It has built in support for MDX.To get started, install
11+
Node.js, and Vue. It has built in support for MDX. To get started, install
1212
Zero (globally or locally in your project).
1313

1414
## Installation

docs/guides/custom-loader.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Custom loader
22

3-
By design, the default MDX is very minimal and likely won’t see any additional features outside of the MDX spec.However, webpack [makes it straightforward][webpack-loader] to write your own loader to add custom syntax support.
3+
By design, the default MDX is very minimal and likely won’t see any additional features outside of the MDX spec. However, webpack [makes it straightforward][webpack-loader] to write your own loader to add custom syntax support.
44

5-
Consider a scenario where you wanted to add frontmatter support to all your MDX documents.You could achieve this with a remark plugin or a custom loader. Here we’ll write a custom loader:
5+
Consider a scenario where you wanted to add frontmatter support to all your MDX documents. You could achieve this with a remark plugin or a custom loader. Here we’ll write a custom loader:
66

77
```js
88
// lib/fm-loader.js

docs/guides/live-code.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ If you haven’t read the syntax highlighting guide it’s recommended start the
55
# Live code
66

77
An increasingly common approach for live code editors is to overload the
8-
code block.This is often done so that the code shows up nicely when rendered
8+
code block. This is often done so that the code shows up nicely when rendered
99
to GitHub and it’s a nice usage of meta strings.
1010

1111
## Code block meta string
@@ -15,6 +15,7 @@ be automatically passed as props to your code block.
1515

1616
````md
1717
```js live=true
18+
1819
```
1920
````
2021

@@ -88,7 +89,7 @@ export default props => (
8889
## Using the MDXProvider context for rendering
8990

9091
With the react-live editor you can ensure that your MDX components
91-
in context are rendered in the preview.In order to do this you
92+
in context are rendered in the preview. In order to do this you
9293
can use the MDX custom pragma.
9394

9495
To achieve this, import the pragma:

docs/guides/markdown-in-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ One great feature about MDX is that you can use Markdown within your JSX compone
44

55
## Example
66

7-
Lets say you wanted to create a custom `<Note />` component.You could do something like this.
7+
Lets say you wanted to create a custom `<Note />` component. You could do something like this.
88

99
Using MDX 2:
1010

0 commit comments

Comments
 (0)