fleet-docs/node_modules/@mdx-js/mdx
divya-mohan0209 9de94a264c Initial commit 2022-09-22 09:54:31 +05:30
..
node_modules Initial commit 2022-09-22 09:54:31 +05:30
index.js Initial commit 2022-09-22 09:54:31 +05:30
license Initial commit 2022-09-22 09:54:31 +05:30
md-ast-to-mdx-ast.js Initial commit 2022-09-22 09:54:31 +05:30
mdx-ast-to-mdx-hast.js Initial commit 2022-09-22 09:54:31 +05:30
mdx-hast-to-jsx.js Initial commit 2022-09-22 09:54:31 +05:30
package.json Initial commit 2022-09-22 09:54:31 +05:30
readme.md Initial commit 2022-09-22 09:54:31 +05:30
util.js Initial commit 2022-09-22 09:54:31 +05:30

readme.md

@mdx-js/mdx

Build Status lerna Chat

MDX implementation using remark.

Installation

npm:

npm i -S @mdx-js/mdx

Usage

const mdx = require('@mdx-js/mdx')

const result = await mdx(`
# Hello, MDX

I <3 Markdown and JSX
`)

console.log(result)

Yields:

export default ({components, ...props}) => (
  <MDXTag name="wrapper" components={components}>
    <MDXTag name="h1" components={components}>{`Hello, MDX`}</MDXTag>
    <MDXTag name="p" components={components}>{`I <3 Markdown and JSX`}</MDXTag>
  </MDXTag>
)

Contribute

See the Support and Contributing guidelines on the MDX website for ways to (get) help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Compositor and Vercel