Skip to content

Commit f459b64

Browse files
committed
Refactor docs
1 parent cd117dc commit f459b64

File tree

5 files changed

+23
-31
lines changed

5 files changed

+23
-31
lines changed

docs/community/about.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export const info = {
44
author: [
55
{github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
66
],
7-
modified: new Date('2021-11-01'),
7+
modified: new Date('2024-10-18'),
88
published: new Date('2021-10-06')
99
}
1010
export const navSortSelf = 4
@@ -82,11 +82,6 @@ this project!
8282
The following projects, languages, and articles helped shape MDX either in
8383
implementation or inspiration.
8484

85-
<Note type="info">
86-
**Note**: Is your work missing?
87-
Please open a PR if we failed to attribute your work.
88-
</Note>
89-
9085
The [markdown][] and [JSX][] languages inspired MDX.
9186
Markdown was [created by John Gruber][markdown] (**[@gruber][gruber]**).
9287
[CommonMark][], the most popular markdown variant, by John McFarlane

docs/docs/extending-mdx.mdx

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export const info = {
44
author: [
55
{github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
66
],
7-
modified: new Date('2024-07-04'),
7+
modified: new Date('2024-10-18'),
88
published: new Date('2021-10-06')
99
}
1010
export const navSortSelf = 4
@@ -31,8 +31,8 @@ integrations:
3131

3232
* Options passed to the compiler (see [¶ API in `@mdx-js/mdx`][api])
3333
* Plugins that hook into several stages of compilation (see [remark
34-
plugins][remark-plugins], [rehype plugins][rehype-plugins], and the new
35-
recma plugins)
34+
plugins][remark-plugins], [rehype plugins][rehype-plugins], and
35+
[recma plugins][recma-plugins])
3636
* Components passed, defined, or imported at runtime (see [§ Using MDX][use])
3737

3838
Most of the time, these components and plugins are not coupled to MDX.
@@ -68,8 +68,9 @@ We’re compiling those here on this page.
6868

6969
### List of plugins
7070

71-
See also the [list of remark plugins][remark-plugins] and
72-
[list of rehype plugins][rehype-plugins].
71+
See also the [list of remark plugins][remark-plugins],
72+
[list of rehype plugins][rehype-plugins], and
73+
[list of recma plugins][recma-plugins].
7374

7475
* [`remcohaszing/recma-export-filepath`](https://github.com/remcohaszing/recma-export-filepath)
7576
— export the filepath
@@ -116,8 +117,10 @@ See also the [list of remark plugins][remark-plugins] and
116117

117118
## Using plugins
118119

119-
Where to pass plugins is encoded in their name: remark plugins go in
120-
`remarkPlugins` and rehype plugins go in `rehypePlugins` of
120+
Where to pass plugins is encoded in their name:
121+
remark plugins go in `remarkPlugins`,
122+
rehype plugins go in `rehypePlugins`,
123+
and recma plugins go in `recmaPlugins` of
121124
[`ProcessorOptions`][processor-options].
122125
Those fields expect lists of plugins and/or of `[plugin, options]`:
123126

@@ -155,8 +158,8 @@ await compile(file, {
155158

156159
## Creating plugins
157160

158-
Creating a plugin for MDX is mostly the same as creating a plugin for remark
159-
or rehype.
161+
Creating a plugin for MDX is mostly the same as creating a plugin for remark,
162+
rehype, or recma.
160163
There are several guides and recipes on that in [§ Learn on
161164
`unifiedjs.com`][learn].
162165

@@ -166,6 +169,8 @@ For info on the node types that represent MDX specific features, see
166169
[¶ Syntax tree in `remark-mdx`][syntax-tree] and use our interactive
167170
[§ Playground][playground].
168171

172+
[recma-plugins]: https://github.com/mdx-js/recma/blob/main/doc/plugins.md#list-of-plugins
173+
169174
[remark-plugins]: https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins
170175

171176
[rehype-plugins]: https://github.com/rehypejs/rehype/blob/main/doc/plugins.md#list-of-plugins

docs/docs/getting-started.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export const info = {
44
author: [
55
{github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
66
],
7-
modified: new Date('2024-07-04'),
7+
modified: new Date('2024-10-18'),
88
published: new Date('2021-10-05')
99
}
1010
export const navSortSelf = 2
@@ -44,9 +44,8 @@ Note that we do compile JSX to JavaScript for you so you don’t have to set tha
4444
up.
4545

4646
All `@mdx-js/*` packages are written in modern JavaScript.
47-
A [Node.js][node-js] version of 16.0 or later is needed to use them.
48-
Our packages are also [ESM only][github-gist-esm],
49-
so they have to be `import`ed instead of `require`d.
47+
A [Node.js][node-js] version of 16 or later is needed to use them.
48+
Our packages are also [ESM only][github-gist-esm].
5049

5150
<Note type="info">
5251
**Note**: Using Rust instead of Node.js?

docs/docs/using-mdx.mdx

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export const info = {
44
author: [
55
{github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
66
],
7-
modified: new Date('2024-07-04'),
7+
modified: new Date('2024-10-18'),
88
published: new Date('2021-09-30')
99
}
1010
export const navSortSelf = 3
@@ -390,14 +390,7 @@ That’s because `a` is the HTML equivalent for the markdown syntax being used.
390390
The second link (`#bravo`) remains unchanged,
391391
because in JSX syntax `a` is a literal tag name.
392392
The third link (`#charlie`) is dashed and tomato,
393-
as in JSX syntax `Link` is a reference.
394-
395-
<Note type="info">
396-
**Note**:
397-
Users of the MDX VS Code extension can add type
398-
checking of provided and passed components with a JSDoc comment.
399-
See [`mdx-js/mdx-analyzer`][mdx-analyzer] for more info.
400-
</Note>
393+
because in JSX syntax `Link` is a reference.
401394
402395
### Layout
403396

docs/table-of-components.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const info = {
33
{github: 'johno', name: 'John Otander', twitter: '4lpine'},
44
{github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
55
],
6-
modified: new Date('2021-11-01'),
6+
modified: new Date('2024-10-18'),
77
published: new Date('2020-03-11')
88
}
99
export const navSortSelf = 4
@@ -105,7 +105,7 @@ More information on how to use markdown can be found in [CommonMark][].
105105
````mdx chrome=no
106106
Some `backticks` for inline.
107107

108-
```tsx
108+
```javascript
109109
backtick.fences('for blocks')
110110
```
111111
````
@@ -357,7 +357,7 @@ More information on how to use markdown can be found in [CommonMark][].
357357

358358
<td>
359359
````mdx chrome=no
360-
```tsx
360+
```javascript
361361
backtick.fences('for blocks')
362362
```
363363
````

0 commit comments

Comments
 (0)