https://github.com/nuxt-community/mdx-module
MDX module for Nuxt 2
https://github.com/nuxt-community/mdx-module
mdx nuxt nuxt-module
Last synced: 6 months ago
JSON representation
MDX module for Nuxt 2
- Host: GitHub
- URL: https://github.com/nuxt-community/mdx-module
- Owner: nuxt-community
- License: mit
- Created: 2020-05-14T16:20:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T21:52:13.000Z (6 months ago)
- Last Synced: 2024-11-19T22:40:54.122Z (6 months ago)
- Topics: mdx, nuxt, nuxt-module
- Language: JavaScript
- Homepage: https://mdx.nuxtjs.org
- Size: 491 KB
- Stars: 47
- Watchers: 3
- Forks: 7
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://mdx.nuxtjs.org)
# @nuxtjs/mdx
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
> [MDX](https://mdxjs.com) module for [Nuxt 2](https://nuxt.com)
- [✨ Release Notes](https://mdx.nuxtjs.org/releases)
- [📖 Documentation](https://mdx.nuxtjs.org)
## Features
- Import `.mdx` files as Vue components
- Import Vue components in your `.mdx` files
- Replace markdown elements with Vue components with the MDX Provider.
## Development
1. Clone this repository
2. Install dependencies using `yarn`
3. Start development server using `yarn dev`
## License
[MIT License](./LICENSE)
Copyright (c) Nuxt Community
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/mdx/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxtjs/mdx
[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/mdx.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/mdx
[github-actions-ci-src]: https://github.com/nuxt-community/mdx-module/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt-community/mdx-module/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/mdx-module.svg
[codecov-href]: https://codecov.io/gh/nuxt-community/mdx-module
[license-src]: https://img.shields.io/npm/l/@nuxtjs/mdx.svg
[license-href]: https://npmjs.com/package/@nuxtjs/mdx