Skip to content

Commit

Permalink
Bump deps, update docs for new lint rule (#605)
Browse files Browse the repository at this point in the history
  • Loading branch information
johno committed Jun 17, 2019
1 parent 1808386 commit 87ae231
Show file tree
Hide file tree
Showing 10 changed files with 584 additions and 371 deletions.
6 changes: 3 additions & 3 deletions docs/blog/v1.md
Expand Up @@ -4,7 +4,7 @@

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

Since announcing MDX we’ve been working on numerous bug fixes, new features, better parsing, and integration
tests. Now, we think it’s ready. **We’re happy to finally release v1!**
Expand All @@ -24,8 +24,8 @@ Please open an issue if you find a case we haven’t covered! 😸
### remark-mdx

`remark-mdx` is the syntactic extension for MDX in remark. It provides the parsing functionality for
MDX as a _[remark](https://github.com/remarkjs/remark) plugin_. That sounds a bit meta. What it means
is that before we had the syntax parsing bits _in_ the library (unusable from the outside), and now it’s
MDX as a *[remark](https://github.com/remarkjs/remark) plugin*. That sounds a bit meta. What it means
is that before we had the syntax parsing bits *in* the library (unusable from the outside), and now it’s
externalized (usable from the outside). This is useful if you want to inspect or transform MDX documents.
For example, it allows tools like prettier to use the exact same parser used by MDX core. Or you could
use `remark-mdx` in combination with [remark-lint](https://github.com/remarkjs/remark-lint) to check your
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
Expand Up @@ -364,7 +364,7 @@ Sometimes from an MDX file you might want to override the wrapper.
This is especially useful when you want to override layout for a single entry
point at the page level.
To achieve this you can use the ES default [export][] and it will wrap your MDX
document _instead_ of the wrapper passed to MDXProvider.
document *instead* of the wrapper passed to MDXProvider.

You can declare a default export as a function:

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/webpack.md
Expand Up @@ -47,7 +47,7 @@ module.exports = {
If you only want the loader for `.mdx` files you can change the regex to `/\.mdx$/`.

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

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/wrapper-customization.md
Expand Up @@ -9,13 +9,13 @@ it has access to the children passed to it.

This means that you can do powerful things with the MDX document elements.
If you aren’t very familiar with React children, it might be worthwile to
start with [_A deep dive into children in React_](https://mxstbr.blog/2017/02/react-children-deepdive/)
start with [*A deep dive into children in React*](https://mxstbr.blog/2017/02/react-children-deepdive/)
by Max Stoiber.

> We can render arbitrary components as children, but still control them from the
> parent instead of the component we render them from.
>
> _Max Stoiber - A deep dive into children in React_
> *Max Stoiber - A deep dive into children in React*
The implications of this are very interesting from the context of an
MDX wrapper component. This means the wrapper can do things like reordering
Expand Down Expand Up @@ -119,7 +119,7 @@ export default props => (
## Related

If you would like to dive deeper, check out
[_A deep dive into children in React_](https://mxstbr.blog/2017/02/react-children-deepdive/)
[*A deep dive into children in React*](https://mxstbr.blog/2017/02/react-children-deepdive/)
or Brent Jackson’s [MDX Blocks](https://github.com/jxnblk/mdx-blocks)

* * *
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/writing-a-plugin.md
Expand Up @@ -25,7 +25,7 @@ module.exports = () => (tree, file) => {
This will log out all the nodes in your document that are headings. Inside heading nodes there are text nodes. These
include the raw text included in the heading.

_Note_: The reason that heading nodes include multiple text node types is because there can be other
*Note*: The reason that heading nodes include multiple text node types is because there can be other
[phrasing content][phrasing]” nodes. For example if your heading looked like `# Hello, _world_`. In addition to the
text there is also an emphasis node.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Expand Up @@ -46,7 +46,7 @@ Before MDX, some of the benefits of writing Markdown were lost when integrating
with JSX. Implementations were often template string-based which required lots
of escaping and cumbersome syntax.

MDX seeks to make writing with Markdown _and_ JSX simpler while being more
MDX seeks to make writing with Markdown *and* JSX simpler while being more
expressive. Writing is fun again when you combine components, that can
even be dynamic or load data, with the simplicity of Markdown for long-form
content.
Expand Down
6 changes: 3 additions & 3 deletions examples/syntax-highlighting/package.json
Expand Up @@ -9,10 +9,10 @@
"dependencies": {
"@mdx-js/mdx": "^1.0.20",
"@mdx-js/react": "^1.0.20",
"gatsby": "^2.3.21",
"gatsby-mdx": "^0.6.1",
"gatsby": "^2.9.4",
"gatsby-mdx": "^0.6.3",
"prism-react-renderer": "^0.1.6",
"react-live": "^2.0.1",
"react-live": "^2.1.2",
"unified-ui": "^0.0.3"
}
}
20 changes: 10 additions & 10 deletions package.json
Expand Up @@ -6,18 +6,18 @@
"bugs": "https://github.com/mdx-js/mdx/issues",
"devDependencies": {
"eslint": "^5.16.0",
"eslint-config-prettier": "^4.1.0",
"eslint-config-prettier": "^5.0.0",
"eslint-config-xo": "^0.26.0",
"eslint-plugin-import": "^2.17.2",
"eslint-plugin-prettier": "^3.0.1",
"eslint-plugin-react": "^7.12.4",
"gatsby": "^2.3.24",
"husky": "^1.3.1",
"lerna": "^3.13.3",
"lint-staged": "^8.1.5",
"prettier": "^1.17.0",
"eslint-plugin-import": "^2.17.3",
"eslint-plugin-prettier": "^3.1.0",
"eslint-plugin-react": "^7.13.0",
"gatsby": "^2.9.4",
"husky": "^2.4.1",
"lerna": "^3.15.0",
"lint-staged": "^8.2.1",
"prettier": "^1.18.2",
"remark-cli": "^6.0.1",
"remark-preset-wooorm": "^4.0.0"
"remark-preset-wooorm": "^5.0.0"
},
"scripts": {
"bootstrap": "lerna bootstrap && lerna link --force-local",
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Expand Up @@ -70,7 +70,7 @@ and cumbersome syntax.
>
> [@chrisbiscardi][tweet]
MDX seeks to make writing with markdown _and_ JSX simpler while being more
MDX seeks to make writing with markdown *and* JSX simpler while being more
expressive.
The possibilities are endless when you combine components (that can even be
dynamic or load data) with the simplicity of markdown for long-form content.
Expand Down

1 comment on commit 87ae231

@vercel
Copy link

@vercel vercel bot commented on 87ae231 Jun 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.