46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# [remark][]-[mdx][]
|
|
|
|
[![Build Status][build-badge]][build]
|
|
[![lerna][lerna-badge]][lerna]
|
|
[![Chat][chat-badge]][chat]
|
|
|
|
> :warning: This project is currently in alpha
|
|
|
|
[MDX][] syntax support for [remark][].
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
npm install --save remark-mdx
|
|
```
|
|
|
|
## 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][] © [Titus Wormer][author] and [John Otander][author2]
|
|
|
|
<!-- 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
|
|
[mdx]: https://github.com/mdx-js/mdx
|
|
[author]: https://wooorm.com
|
|
[author2]: https://johno.com
|