{"id":"f7aa234f2d0343a61852f4d719350e9849ae6b80bd127bd83add0b1abe5229bd","type":"Contented","path":"/markdown","modifiedDate":1686373756200,"sections":[],"fields":{"title":"Markdown Features","description":"The dialect of Markdown that is currently supported for contented","tags":["Markdown","Frontmatter","Admonitions","Mermaid"]},"html":"

Markdown Features

\n

Contented unified processor pipeline.

\n
processor\n  .use(options.before)\n  .use(remarkGfm)\n  .use(remarkFrontmatter)\n  .use(remarkParse)\n  .use(remarkLink)\n  .use(remarkDirective)\n  .use(remarkDirectiveRehype)\n  .use(collectFields)\n  .use(resolveFields)\n  .use(validateFields)\n  .use(options.remarks)\n  .use(remarkRehype)\n  .use(options.rehypes)\n  .use(rehypeExternalLinks, { target: '_blank' })\n  .use(rehypeSlug)\n  .use(rehypeAutolinkHeadings)\n  .use(rehypeToc)\n  .use(rehypeHeading)\n  .use(rehypeMermaid)\n  .use(rehypeShiki, { highlighter })\n  .use(rehypeStringify)\n  .use(options.after);
\n

GitHub Flavour Markdown

\n

GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is\ncurrently supported for user content on GitHub.com and GitHub Enterprise.

\n

This formal specification, based on the CommonMark Spec, defines the syntax and semantics of this dialect.

\n

Frontmatter

\n
---\ntitle: Markdown Flavour\n---
\n

Admonitions

\n

Admonitions with remark-directive and remark-directive-rehype.

\n

This is div{class=\"admonitions\"}.

:::div{class=\"admonitions\"}\nThis is `div{class=\"admonitions\"}`.\n:::\n
\n

This is div{class=\"admonitions red\"}.

:::div{class=\"admonitions red\"}\nThis is `div{class=\"admonitions red\"}`.\n:::\n
\n

This is div{class=\"admonitions yellow\"}.

:::div{class=\"admonitions yellow\"}\nThis is `div{class=\"admonitions yellow\"}`.\n:::\n
\n

This is div{class=\"admonitions green\"}.

:::div{class=\"admonitions green\"}\nThis is `div{class=\"admonitions green\"}`.\n:::\n
\n

Mermaid

\n
```mermaid\ngraph LR\n    Start --> Stop\n```\n
\n
graph LR\n Start --> Stop\n
\n
```mermaid\n  graph TD;\n      A-->B;\n      A-->C;\n      B-->D;\n      C-->D;\n```\n
\n
graph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n
","headings":[{"depth":1,"id":"markdown-features","title":"Markdown Features","children":[{"depth":2,"id":"github-flavour-markdown","title":"GitHub Flavour Markdown","children":[]},{"depth":2,"id":"frontmatter","title":"Frontmatter","children":[]},{"depth":2,"id":"admonitions","title":"Admonitions","children":[]},{"depth":2,"id":"mermaid","title":"Mermaid","children":[]}]}]}