https://github.com/robot-inventor/qnote
Parser for Qiita note notation
https://github.com/robot-inventor/qnote
Last synced: about 1 year ago
JSON representation
Parser for Qiita note notation
- Host: GitHub
- URL: https://github.com/robot-inventor/qnote
- Owner: Robot-Inventor
- License: mit
- Created: 2022-03-13T09:21:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:22:09.000Z (over 1 year ago)
- Last Synced: 2024-10-27T09:33:45.262Z (over 1 year ago)
- Language: TypeScript
- Size: 216 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qnote-parser
[Marked](https://github.com/markedjs/marked) extension for parsing [Qiita note notation](https://qiita.com/Qiita/items/c686397e4a0f4f11683d#note---%E8%A3%9C%E8%B6%B3%E8%AA%AC%E6%98%8E).
## Installation
```shell
npm install qnote-parser
```
## Usage
```javascript
import { marked } from "marked";
import { qnote } from "qnote-parser";
marked.use({ extensions: [qnote] });
const markdown = `Hello.
:::note info
This is **note** notation.
Paragraph is supported.
:::
Good-bye!`;
console.log(marked.parse(markdown));
```
result:
```html
Hello.
This is note notation.
Paragraph is supported.
Good-bye!
```