remark-code-example
Remark plugin to copy live code block as code example.
Installation
npm install remark remark-code-example --save-dev
Usage
import readFileSync from 'fs';
import { remark } from 'remark';
import { remarkCodeExample } from 'remark-code-example';
const markdownText = readFileSync('example.md', 'utf8');
remark()
.use(remarkCodeSample, {})
.process(markdownText)
.then((file) => console.info(file))
.catch((error) => console.warn(error));
Options.metas
- type: object of string
- default: {}
- required: false
- description: Metas of example code block
Syntax
code-example
Turn
```mermaid code-example
flowchart
Start --> Stop
```
Into
````markdown
```mermaid
flowchart
Start --> Stop
```
````
code-example-copy
Turn
```mermaid code-example-copy
flowchart
Start --> Stop
```
Into
```mermaid
flowchart
Start --> Stop
```
````markdown
```mermaid
flowchart
Start --> Stop
```
````
code-alias-copy
Turn
```mermaid code-alias-copy=diagram
flowchart
Start --> Stop
```
Into
```mermaid
flowchart
Start --> Stop
```
```diagram
flowchart
Start --> Stop
```