https://github.com/show-docs/markdown-code-block-meta
A library to parse/stringify metadata of markdown code block
https://github.com/show-docs/markdown-code-block-meta
code-block key-value markdown meta metadata pair remark
Last synced: 5 months ago
JSON representation
A library to parse/stringify metadata of markdown code block
- Host: GitHub
- URL: https://github.com/show-docs/markdown-code-block-meta
- Owner: show-docs
- License: mit
- Created: 2022-08-09T06:43:36.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T04:05:48.000Z (about 2 years ago)
- Last Synced: 2025-07-12T16:22:42.535Z (6 months ago)
- Topics: code-block, key-value, markdown, meta, metadata, pair, remark
- Language: JavaScript
- Homepage:
- Size: 154 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown-code-block-meta
A library to parse/stringify metadata of markdown code block.
[![npm][npm-badge]][npm-url]
[![github][github-badge]][github-url]
![node][node-badge]
[npm-url]: https://www.npmjs.com/package/markdown-code-block-meta
[npm-badge]: https://img.shields.io/npm/v/markdown-code-block-meta.svg?style=flat-square&logo=npm
[github-url]: https://github.com/nice-move/markdown-code-block-meta
[github-badge]: https://img.shields.io/npm/l/markdown-code-block-meta.svg?style=flat-square&colorB=blue&logo=github
[node-badge]: https://img.shields.io/node/v/markdown-code-block-meta.svg?style=flat-square&colorB=green&logo=node.js
## Installation
```bash
npm install markdown-code-block-meta --save
```
## Usage
Parsing markdown with [remark](https://remark.js.org).
````markdown
```js title="Here is an example"
```
````
A Code block will turn into:
```json
{
"lang": "js",
"meta": "title=\"Here is an example\""
}
```
Parsing metadata like this:
```js
import { getValue, parse, stringify } from 'markdown-code-block-meta';
const input =
'-8=。是 ==0 ===f=5 =9 dd k=dsds op="s 7" d-p="" sss=`7 u-` rj= lp=\' ds ds\' t="`"';
const result = parse(input);
/* result = Map {
'-8' => '。是',
'==0' => undefined,
'===f=5' => undefined,
'=9' => undefined,
'dd' => undefined,
'k' => 'dsds',
'op' => '"s 7"',
'd-p' => '""',
'sss' => '`7 u-`',
'rj=' => undefined,
'lp' => '\' ds ds\'',
't' => '"`"'
} */
stringify(result); // same as input
getValue('"abc"'); // abc
getValue('`abc`'); // abc
getValue("'abc'"); // abc
```
## Related
- [remark-code-example](https://github.com/nice-move/remark-code-example)
- [remark-kroki](https://github.com/nice-move/remark-kroki)
- [remark-docusaurus](https://github.com/nice-move/remark-docusaurus)