Markdown Features
Contented unified processor pipeline.
processor
.use(options.before)
.use(remarkGfm)
.use(remarkFrontmatter)
.use(remarkParse)
.use(remarkLink)
.use(remarkDirective)
.use(remarkDirectiveRehype)
.use(collectFields)
.use(resolveFields)
.use(validateFields)
.use(options.remarks)
.use(remarkRehype)
.use(options.rehypes)
.use(rehypeExternalLinks, { target: '_blank' })
.use(rehypeSlug)
.use(rehypeAutolinkHeadings)
.use(rehypeToc)
.use(rehypeHeading)
.use(rehypeMermaid)
.use(rehypeShiki, { highlighter })
.use(rehypeStringify)
.use(options.after);
GitHub Flavour Markdown
GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise.
This formal specification, based on the CommonMark Spec, defines the syntax and semantics of this dialect.
Frontmatter
---
title: Markdown Flavour
---
Admonitions
Admonitions with remark-directive
and remark-directive-rehype
.
This is div{class="admonitions"}
.
:::div{class="admonitions"}
This is `div{class="admonitions"}`.
:::
This is div{class="admonitions red"}
.
:::div{class="admonitions red"}
This is `div{class="admonitions red"}`.
:::
This is div{class="admonitions yellow"}
.
:::div{class="admonitions yellow"}
This is `div{class="admonitions yellow"}`.
:::
This is div{class="admonitions green"}
.
:::div{class="admonitions green"}
This is `div{class="admonitions green"}`.
:::
Mermaid
```mermaid
graph LR
Start --> Stop
```
graph LR
Start --> Stop
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;