marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-12-02 10:34:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3954 from aloisklink/build/support-GFM-in-markdown-documentation

Browse Source 
Support GitHub Flavored Markdown in markdown documentation
This commit is contained in:
Sidharth Vinod
2023-01-12 12:47:07 +05:30
committed by GitHub
parent 3238ee4c2e 75b19eaa0c
commit 9acd562b9e
11 changed files with 241 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
packages/mermaid/package.json
View File

@@ -89,6 +89,7 @@
"path-browserify": "^1.0.1",
"prettier": "^2.7.1",
"remark": "^14.0.2",
"remark-gfm": "^3.0.1",
"rimraf": "^3.0.2",
"start-server-and-test": "^1.14.0",
"typedoc": "^0.23.18",

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

@@ -37,12 +37,16 @@ import { JSDOM } from 'jsdom';
import type { Code, Root } from 'mdast';
import { posix, dirname, relative, join } from 'path';
import prettier from 'prettier';
import { remark } from 'remark';
import { remark as remarkBuilder } from 'remark';
import remarkGfm from 'remark-gfm';
import chokidar from 'chokidar';
import mm from 'micromatch';
// @ts-ignore No typescript declaration file
import flatmap from 'unist-util-flatmap';
// support tables and other GitHub Flavored Markdown syntax in markdown
const remark = remarkBuilder().use(remarkGfm);
const MERMAID_MAJOR_VERSION = (
JSON.parse(readFileSync('../mermaid/package.json', 'utf8')).version as string
).split('.')[0];