gnezim
72 lines
1.6 KiB
Markdown
72 lines
1.6 KiB
Markdown
# `@mdx-js/mdx`
|
|
|
|
[![Build Status][build-badge]][build]
|
|
[![lerna][lerna-badge]][lerna]
|
|
[![Chat][chat-badge]][chat]
|
|
|
|
[MDX][] implementation using [remark][].
|
|
|
|
## Installation
|
|
|
|
[npm][]:
|
|
|
|
```sh
|
|
npm i -S @mdx-js/mdx
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const mdx = require('@mdx-js/mdx')
|
|
|
|
const result = await mdx(`
|
|
# Hello, MDX
|
|
|
|
I <3 Markdown and JSX
|
|
`)
|
|
|
|
console.log(result)
|
|
```
|
|
|
|
Yields:
|
|
|
|
```js
|
|
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][coc].
|
|
By interacting with this repository, organisation, or community you agree to
|
|
abide by its terms.
|
|
|
|
## License
|
|
|
|
[MIT][] © [Compositor][] and [Vercel][]
|
|
|
|
<!-- Definitions -->
|
|
|
|
[build]: https://travis-ci.com/mdx-js/mdx
|
|
[build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
|
|
[lerna]: https://lerna.js.org/
|
|
[lerna-badge]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
|
|
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
|
[chat]: https://github.com/mdx-js/mdx/discussions
|
|
[contributing]: https://mdxjs.com/contributing
|
|
[support]: https://mdxjs.com/support
|
|
[coc]: https://github.com/mdx-js/.github/blob/master/code-of-conduct.md
|
|
[mit]: license
|
|
[remark]: https://github.com/remarkjs/remark
|
|
[compositor]: https://compositor.io
|
|
[vercel]: https://vercel.com
|
|
[mdx]: https://github.com/mdx-js/mdx
|
|
[npm]: https://docs.npmjs.com/cli/install
|