@bevry/mdx
TypeScript icon, indicating that this package has built-in type declarations

3.6.0 • Public • Published

@bevry/mdx

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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

Deno

import pkg from 'https://unpkg.com/@bevry/mdx@^3.6.0/edition-deno/index.ts'

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-es2022/index.js
  • @bevry/mdx/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • @bevry/mdx/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • @bevry/mdx/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • @bevry/mdx/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

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

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under:

Package Sidebar

Install

npm i @bevry/mdx

Weekly Downloads

1,312

Version

3.6.0

License

Artistic-2.0

Unpacked Size

46.4 kB

Total Files

15

Last publish

Collaborators

  • bevryme