mdx-to-md
Convert MDX to Markdown.
Why?
This library is most useful for generating README.md files like the one you're reading.
Install
yarn add mdx-to-md
npm install mdx-to-md
CLI
mdx-to-md [sourcePath] [outPath]
In the simplest use case, you can run the CLI and it will output the converted Markdown relative to the current working directory the script was run in:
yarn mdx-to-md README.mdx
Node
Start with MDX:
import { name, description } from "./package.json"
# {name}
{description}
# Install
<pre>
<code className="language-bash">yarn add {name}</code>
</pre>
And convert it to Markdown:
import { writeFile } from "fs/promises"
import { mdxToMarkdown } from "mdx-to-md"
const markdown = await mdxToMarkdown("README.mdx")
const banner = `This README was auto-generated using "yarn build:readme"`
const readme = `<!--- ${banner} --> \n\n ${markdown}`
await writeFile("README.md", readme)
console.log("📝 Converted README.mdx -> README.md")
Which outputs:
# mdx-to-md
Convert MDX to Markdown.
# Install
yarn add mdx-to-md
15 Dec 31, 2022
91 Jan 2, 2023
25 Dec 20, 2022
7 Dec 13, 2022
13 Jan 2, 2023
1 Dec 24, 2021
18 Dec 26, 2022
4 Mar 25, 2022
141 Jan 2, 2023
3 Jul 5, 2022