Skip to content

Commit 8b3dd9e

Browse files
committed
Add support for formatting options
1 parent b6896e8 commit 8b3dd9e

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

index.js

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
* @typedef {import('mdast-util-mdx-jsx').MdxJsxExpressionAttribute} MdxJsxExpressionAttribute
1010
* @typedef {import('mdast-util-mdx-jsx').MdxJsxFlowElement} MdxJsxFlowElement
1111
* @typedef {import('mdast-util-mdx-jsx').MdxJsxTextElement} MdxJsxTextElement
12+
*
13+
* @typedef {import('mdast-util-mdx-jsx').ToMarkdownOptions} ToMarkdownOptions
1214
*/
1315

1416
import {
@@ -19,19 +21,21 @@ import {mdxJsxFromMarkdown, mdxJsxToMarkdown} from 'mdast-util-mdx-jsx'
1921
import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
2022

2123
/**
22-
*
2324
* @return {Array<FromMarkdownExtension>}
2425
*/
2526
export function mdxFromMarkdown() {
2627
return [mdxExpressionFromMarkdown, mdxJsxFromMarkdown(), mdxjsEsmFromMarkdown]
2728
}
2829

29-
/** @return {ToMarkdownExtension} */
30-
export function mdxToMarkdown() {
30+
/**
31+
* @param {ToMarkdownOptions} [options]
32+
* @return {ToMarkdownExtension}
33+
*/
34+
export function mdxToMarkdown(options) {
3135
return {
3236
extensions: [
3337
mdxExpressionToMarkdown,
34-
mdxJsxToMarkdown(),
38+
mdxJsxToMarkdown(options),
3539
mdxjsEsmToMarkdown
3640
]
3741
}

readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,14 +228,14 @@ There is no default export.
228228

229229
### `mdxFromMarkdown()`
230230

231-
### `mdxToMarkdown()`
231+
### `mdxToMarkdown(options?)`
232232

233233
Support MDX (or MDX.js).
234234
The exports are functions that can be called to respectively get an extension
235235
for [`mdast-util-from-markdown`][from-markdown] and
236236
[`mdast-util-to-markdown`][to-markdown].
237237

238-
There are no options.
238+
The options to `mdxToMarkdown` are [passed to `mdxJsxToMarkdown`][options].
239239

240240
## Related
241241

@@ -323,3 +323,5 @@ abide by its terms.
323323
[mdxjs]: https://github.com/micromark/micromark-extension-mdxjs
324324

325325
[remark-mdx]: https://github.com/mdx-js/mdx/tree/next/packages/remark-mdx
326+
327+
[options]: https://github.com/syntax-tree/mdast-util-mdx-jsx#mdxjsxtomarkdownoptions

0 commit comments

Comments
 (0)