PJCHENder 未整理筆記

[NPM] Unified remarkjs

2020-06-18

[NPM] Unified remarkjs

remarkjs

remarkjs 是透過 unified 的流程來處理 markdown 的檔案,它透過 unified API 提供的流程,透過 remark-parse 將 markdown 檔案解析成 markdown syntax tree (mdast),接著可以使用 unified 的 plugin 來對該 markdown 進行操作,最後則透過 remark-stringify 來輸出成修改後的 markdown。

remark-parse

1
2
3
4
5
6
7
// 取得 markdown tree
const unified = require('unified');
const markdown = require('remark-parse');

const tree = unified()
.use(markdown) // parser
.parse('# Hello world!');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// parser -> compile -> 寫檔
const markdown = require('remark-parse');
const stringify = require('remark-stringify');

const tree = unified()
.use(markdown) // parser
.use(stringify) // compiler
.process(vfile.readSync('blog.md'), function (err, file) {
console.error(report(err || file));
if (file) {
file.extname = '.txt';
vfile.writeSync(file); // Written to `index.html`.
}
});

掃描二維條碼,分享此文章