12
12
13
13
## Contents
14
14
15
- * [ What is this?] ( #what-is-this )
16
- * [ When to use this] ( #when-to-use-this )
17
- * [ Install] ( #install )
18
- * [ Use] ( #use )
19
- * [ API] ( #api )
20
- * [ ` mdxjs(options?) ` ] ( #mdxjsoptions )
21
- * [ ` Options ` ] ( #options )
22
- * [ Authoring] ( #authoring )
23
- * [ Syntax] ( #syntax )
24
- * [ Errors] ( #errors )
25
- * [ Types] ( #types )
26
- * [ Compatibility] ( #compatibility )
27
- * [ Security] ( #security )
28
- * [ Related] ( #related )
29
- * [ Contribute] ( #contribute )
30
- * [ License] ( #license )
15
+ * [ What is this?] ( #what-is-this )
16
+ * [ When to use this] ( #when-to-use-this )
17
+ * [ Install] ( #install )
18
+ * [ Use] ( #use )
19
+ * [ API] ( #api )
20
+ * [ ` mdxjs(options?) ` ] ( #mdxjsoptions )
21
+ * [ ` Options ` ] ( #options )
22
+ * [ Authoring] ( #authoring )
23
+ * [ Syntax] ( #syntax )
24
+ * [ Errors] ( #errors )
25
+ * [ Types] ( #types )
26
+ * [ Compatibility] ( #compatibility )
27
+ * [ Security] ( #security )
28
+ * [ Related] ( #related )
29
+ * [ Contribute] ( #contribute )
30
+ * [ License] ( #license )
31
31
32
32
## What is this?
33
33
@@ -50,14 +50,14 @@ include Rust or variables or whatnot, use
50
50
51
51
Alternatively, you can also use the underlying syntax extensions separately:
52
52
53
- * [ ` micromark-extension-mdx-expression ` ] [ micromark-extension-mdx-expression ]
54
- — support MDX expressions
55
- * [ ` micromark-extension-mdx-jsx ` ] [ micromark-extension-mdx-jsx ]
56
- — support MDX JSX
57
- * [ ` micromark-extension-mdx-md ` ] [ micromark-extension-mdx-md ]
58
- — turn some CommonMark features off
59
- * [ ` micromark-extension-mdxjs-esm ` ] [ micromark-extension-mdxjs-esm ]
60
- — support MDX export/imports
53
+ * [ ` micromark-extension-mdx-expression ` ] [ micromark-extension-mdx-expression ]
54
+ — support MDX expressions
55
+ * [ ` micromark-extension-mdx-jsx ` ] [ micromark-extension-mdx-jsx ]
56
+ — support MDX JSX
57
+ * [ ` micromark-extension-mdx-md ` ] [ micromark-extension-mdx-md ]
58
+ — turn some CommonMark features off
59
+ * [ ` micromark-extension-mdxjs-esm ` ] [ micromark-extension-mdxjs-esm ]
60
+ — support MDX export/imports
61
61
62
62
When you need a syntax tree, combine this package with
63
63
[ ` mdast-util-mdx ` ] [ mdast-util-mdx ] .
@@ -126,8 +126,8 @@ Create an extension for `micromark` to enable MDX syntax.
126
126
127
127
###### Parameters
128
128
129
- * ` options ` ([ ` Options ` ] [ api-options ] , optional)
130
- — configuration; passed to all extensions
129
+ * ` options ` ([ ` Options ` ] [ api-options ] , optional)
130
+ — configuration; passed to all extensions
131
131
132
132
###### Returns
133
133
@@ -150,28 +150,28 @@ See [`Options`][micromark-extension-mdx-expression-options].
150
150
151
151
For recommendations on how to author MDX, see each corresponding readme:
152
152
153
- * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#authoring )
154
- * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#authoring )
155
- * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#authoring )
156
- * [ CommonMark features not in MDX] ( https://github.com/micromark/micromark-extension-mdx-md#authoring )
153
+ * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#authoring )
154
+ * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#authoring )
155
+ * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#authoring )
156
+ * [ CommonMark features not in MDX] ( https://github.com/micromark/micromark-extension-mdx-md#authoring )
157
157
158
158
## Syntax
159
159
160
160
For info on the syntax of these features, see each corresponding readme:
161
161
162
- * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#syntax )
163
- * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#syntax )
164
- * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#syntax )
165
- * CommonMark features not in MDX: n/a
162
+ * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#syntax )
163
+ * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#syntax )
164
+ * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#syntax )
165
+ * CommonMark features not in MDX: n/a
166
166
167
167
## Errors
168
168
169
169
For info on what errors are thrown, see each corresponding readme:
170
170
171
- * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#errors )
172
- * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#errors )
173
- * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#errors )
174
- * CommonMark features not in MDX: n/a
171
+ * [ expressions] ( https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#errors )
172
+ * [ JSX] ( https://github.com/micromark/micromark-extension-mdx-jsx#errors )
173
+ * [ ESM] ( https://github.com/micromark/micromark-extension-mdxjs-esm#errors )
174
+ * CommonMark features not in MDX: n/a
175
175
176
176
## Types
177
177
@@ -196,12 +196,12 @@ This package is safe.
196
196
197
197
## Related
198
198
199
- * [ ` micromark-extension-mdx ` ] [ micromark-extension-mdx ]
200
- — support MDX unaware of JS
201
- * [ ` mdast-util-mdx ` ] [ mdast-util-mdx ]
202
- — support MDX in mdast
203
- * [ ` remark-mdx ` ] [ remark-mdx ]
204
- — support MDX syntax in remark
199
+ * [ ` micromark-extension-mdx ` ] [ micromark-extension-mdx ]
200
+ — support MDX unaware of JS
201
+ * [ ` mdast-util-mdx ` ] [ mdast-util-mdx ]
202
+ — support MDX in mdast
203
+ * [ ` remark-mdx ` ] [ remark-mdx ]
204
+ — support MDX syntax in remark
205
205
206
206
## Contribute
207
207
0 commit comments