-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(integrations-guide): add/format API references blocks #12319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
1dd0711
5596a40
775967a
c8856e7
fb2357d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -271,8 +271,12 @@ MDX does not support passing remark and rehype plugins as a string. You should i | |
|
||
### `extendMarkdownConfig` | ||
|
||
* **Type:** `boolean` | ||
* **Default:** `true` | ||
<p> | ||
|
||
**Type:** `boolean`<br /> | ||
**Default:** `true`<br /> | ||
<Since v="0.15.0" pkg="@astrojs/mdx" /> | ||
</p> | ||
|
||
MDX will extend [your project's existing Markdown configuration](/en/reference/configuration-reference/#markdown-options) by default. To override individual options, you can specify their equivalent in your MDX configuration. | ||
|
||
|
@@ -326,13 +330,25 @@ export default defineConfig({ | |
|
||
### `recmaPlugins` | ||
|
||
<p> | ||
|
||
**Type:** `PluggableList`<br /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Let's ask @delucis ! (Armand's concern is regarding the entry for |
||
**Default:** `[]`<br /> | ||
<Since v="0.11.5" pkg="@astrojs/mdx" /> | ||
</p> | ||
|
||
These are plugins that modify the output [estree](https://github.com/estree/estree) directly. This is useful for modifying or injecting JavaScript variables in your MDX files. | ||
|
||
We suggest [using AST Explorer](https://astexplorer.net/) to play with estree outputs, and trying [`estree-util-visit`](https://unifiedjs.com/explore/package/estree-util-visit/) for searching across JavaScript nodes. | ||
|
||
### `optimize` | ||
|
||
* **Type:** `boolean | { ignoreElementNames?: string[] }` | ||
<p> | ||
|
||
**Type:** `boolean | { ignoreElementNames?: string[] }`<br /> | ||
**Default:** `false`<br /> | ||
<Since v="0.19.5" pkg="@astrojs/mdx" /> | ||
</p> | ||
|
||
This is an optional configuration setting to optimize the MDX output for faster builds and rendering via an internal rehype plugin. This may be useful if you have many MDX files and notice slow builds. However, this option may generate some unescaped HTML, so make sure your site's interactive parts still work correctly after enabling it. | ||
|
||
|
@@ -354,9 +370,12 @@ export default defineConfig({ | |
|
||
#### `ignoreElementNames` | ||
|
||
* **Type:** `string[]` | ||
<p> | ||
|
||
**Type:** `string[]`<br /> | ||
<Since v="3.0.0" pkg="@astrojs/mdx" /> | ||
</p> | ||
|
||
<p><Since pkg="@astrojs/mdx" v="3.0.0" /></p> | ||
Previously known as `customComponentNames`. | ||
|
||
An optional property of `optimize` to prevent the MDX optimizer from handling certain element names, like [custom components passed to imported MDX content via the components prop](/en/guides/integrations-guide/mdx/#custom-components-with-imported-mdx). | ||
|
Uh oh!
There was an error while loading. Please reload this page.