tools: added remark-frontmatter

remark-frontmatter allows the use of frontmatter metadata in markdown files PR-URL: #38717 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Derek Lewis <[email protected]>
nodejs · Sep 4, 2021 · d2c0da2 · d2c0da2
1 parent 1e5aca5
commit d2c0da2
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 0 deletions.
diff --git a/tools/doc/generate.mjs b/tools/doc/generate.mjs
@@ -27,6 +27,7 @@ import htmlStringify from 'rehype-stringify';
 import gfm from 'remark-gfm';
 import markdown from 'remark-parse';
 import remark2rehype from 'remark-rehype';
+import frontmatter from 'remark-frontmatter';
 import unified from 'unified';
 
 import * as html from './html.mjs';
@@ -82,6 +83,7 @@ async function main() {
   const input = await fs.readFile(filename, 'utf8');
 
   const content = await unified()
+    .use(frontmatter)
     .use(replaceLinks, { filename, linksMapper })
     .use(markdown)
     .use(gfm)

diff --git a/tools/doc/package-lock.json b/tools/doc/package-lock.json
diff --git a/tools/doc/package.json b/tools/doc/package.json
@@ -11,6 +11,7 @@
     "js-yaml": "4.1.0",
     "rehype-raw": "5.1.0",
     "rehype-stringify": "8.0.0",
+    "remark-frontmatter": "^3.0.0",
     "remark-gfm": "^1.0.0",
     "remark-html": "13.0.1",
     "remark-parse": "^9.0.0",