remark-code-meta
TypeScript icon, indicating that this package has built-in type declarations

0.4.1 • Public • Published

remark-code-meta

A remark plugin to support meta like filename for markdown code block.

Before:

```js filename=pages/index.js
export default function IndexPage() {
  return <div>hello voidjs</div>
}
```

After:

pages/index.js
export default function IndexPage() {
  return <div>hello voidjs</div>
}

Usage

import remark from 'remark'
import remarkCodeMeta from 'remark-code-meta'
remark().use(remarkCodeMeta, {})

Or

const remark = require('remark')
const { default: remarkCodeMeta } = require('remark-code-meta')
remark().use(remarkCodeMeta, {})

Options

Option Type Default Description
useDetails boolean true use details/summary elements
className string 'remark-code-meta' class to add to element

Supported meta fields

Meta Type Default Description
filename string - set the filename
open boolean true set open for details

Package Sidebar

Install

npm i remark-code-meta

Weekly Downloads

6

Version

0.4.1

License

MIT

Unpacked Size

9.25 kB

Total Files

10

Last publish

Collaborators

  • chenxsan