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
|