Miss any of our Open RFC calls?Watch the recordings here! »

@bevry/mdx

2.12.0 • Public • Published

@bevry/mdx

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

MDX loader for Next.js

Usage

Complete API Documentation.

Create a next.config.js file with the following:

const { withMDX } = require('@bevry/mdx')
module.exports = withMDX(
    {
        pageExtensions: ['js', 'jsx', 'ts', 'tsx', 'md', 'mdx'],
        target: 'serverless',
    },
    {
        extension: /\.mdx?$/,
    }
)

Put your layouts in the layouts directory. The layout should accept a meta property with the metadata from the page.

docmatter is used to parse the document headers.

Install

npm

  • Install: npm install --save @bevry/mdx
  • Import: import pkg from ('@bevry/mdx')
  • Require: const pkg = require('@bevry/mdx').default

Editions

This package is published with the following editions:

  • @bevry/mdx/source/index.ts is TypeScript source code with Import for modules
  • @bevry/mdx aliases @bevry/mdx/edition-esnext/index.js
  • @bevry/mdx/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 13 || 14 with Require for modules
  • @bevry/mdx/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 13 || 14 with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

Install

npm i @bevry/mdx

DownloadsWeekly Downloads

138

Version

2.12.0

License

MIT

Unpacked Size

30.7 kB

Total Files

14

Last publish

Collaborators

  • avatar
  • avatar
  • avatar