An open API service indexing awesome lists of open source software.

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: 5 months ago
JSON representation

MDX module for Nuxt 2

Awesome Lists containing this project

README

        

[![@nuxtjs/mdx](https://mdx.nuxtjs.org/preview.png)](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