marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-23 17:29:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

build(docs): run remark plugins on MermaidConfig

Browse Source 
We use the `unified.stringify()` function on our remark plugins to
stringify the Markdown AST for our MermaidConfig documentation.
However, [`.stringify()`][1] only runs the stringify phase in unified,
not the "run" phase. If we want to run our plugins on the Markdown AST,
we need to also use the [`.run()`][2] function.

[1]: https://github.com/unifiedjs/unified#processorstringifytree-file
[2]: https://github.com/unifiedjs/unified#processorruntree-file-done
This commit is contained in:
Alois Klink
2023-07-13 23:54:49 +01:00
parent 946b5f161e
commit 7cb009cd38
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
packages/mermaid/src/docs.mts
View File

@@ -420,7 +420,7 @@ async function transormJsonSchema(file: string) {
} }
}); });
const transformed = remark() const transformer = remark()
.use(remarkGfm) .use(remarkGfm)
.use(remarkFrontmatter, ['yaml']) // support YAML front-matter in Markdown .use(remarkFrontmatter, ['yaml']) // support YAML front-matter in Markdown
.use(transformMarkdownAst, { .use(transformMarkdownAst, {
@@ -428,8 +428,9 @@ async function transormJsonSchema(file: string) {
originalFilename: file, originalFilename: file,
addAutogeneratedWarning: !noHeader, addAutogeneratedWarning: !noHeader,
removeYAML: !noHeader, removeYAML: !noHeader,
}) });
.stringify(markdownAst as Root);
const transformed = transformer.stringify(await transformer.run(markdownAst as Root));
const formatted = prettier.format(transformed, { const formatted = prettier.format(transformed, {
parser: 'markdown', parser: 'markdown',