Need private packages and team management tools?Check out npm Teams »

inline-mdx.macro

1.0.0 • Public • Published

inline-mdx.macro

Babel Macro

npm version

A babel-macro for converting mdx into an inline component.

/** @jsx mdx */
import { mdx } from '@mdx-js/react'
import { inline } from 'inline-mdx.macro'
 
const SomeMDXComponent = inline`
 
## This is some MDX source
 
<SomeComponent />
 
~~strikethrough~~
`

generates...

/** @jsx mdx */
import { mdx } from '@mdx-js/react'
const SomeMDXComponent = ...;
// you can now do <SomeMDXComponent />

⚠️ Important! ⚠️

You must add the following to any file using the inline macro:

/** @jsx mdx */
import { mdx } from '@mdx-js/react'

This ensures mdx picks up on the jsx code and renders it correctly.

Changes from v0 to v1:

  • Updated to MDX v1
  • Removed the import macro
  • Template strings are now formatted first using the dedent library

Install

npm i inline-mdx.macro

DownloadsWeekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

17.8 kB

Total Files

26

Last publish

Collaborators

  • avatar