-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(mdx-admonitions): add admonitions syntax support
issue #614
- Loading branch information
1 parent
b576692
commit 18540d5
Showing
5 changed files
with
79 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import type { Parent } from 'mdast'; | ||
| import { visit } from 'unist-util-visit'; | ||
|
|
||
| /** | ||
| * Markdown abstract syntax tree node definition. | ||
| * @see https://github.com/syntax-tree/mdast | ||
| */ | ||
| interface ContainerDirective extends Parent { | ||
| name: string; | ||
| attributes: Record<string, string>; | ||
| value?: string; | ||
| } | ||
|
|
||
| export default function remarkAdmonitions() { | ||
| return (tree: any) => { | ||
| visit(tree, (node: ContainerDirective) => { | ||
| if (node.type === 'containerDirective') { | ||
| const title = Object.keys(node.attributes).join(' '); | ||
|
|
||
| // Add `<strong class="admonition-title">{title}</strong>` | ||
| if (title) { | ||
| node.children.unshift({ | ||
| type: 'strong', | ||
| children: [{ type: 'text', value: title }], | ||
| data: { | ||
| hName: 'strong', | ||
| hProperties: { | ||
| className: 'admonition-title', | ||
| }, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| // Change container html element to `<aside class="admonition admonition-*">`, | ||
| node.data = { | ||
| hName: 'aside', | ||
| hProperties: { | ||
| className: `admonition admonition-${node.name}`, | ||
| }, | ||
| }; | ||
| } | ||
| }); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters