Skip to content

About

VSCode extension to show markdown admonitions, Docusaurus style.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Markdown Admonitions

Build Status Marketplace Open VSX

Enables Docusaurus-style and MkDocs-style admonitions in the VS Code preview.

Features

Several static site generators for documentation including Docusaurus have support for informational hints in the documentation. This extension allows for the preview to show Docusaurus and MkDocs admonitions. MkDocs style admonitions fall back to a default and docusaurus style only renders known types.

Examples:

:::note
Remember, the best time to plant a tree was 20 years ago.
The second best time is now. So, plant that code!
:::
!!! note
    *here be dragons*

??? note
    This is hidden unless expanded.

This and the other divs will be displayed like this in dark mode in VS Code:

Parallel sample

They can also be stacked:

Stacked sample

The markdown for the four divs will be shown like above if the extension is enabled. Otherwise they will be four paragraphs of text.

Additional info at Docusaurus.

Based on markdown-it, markdown-it-container and markdown-it-admon.

Requirements

Runs in Visual Studio Code.

Extension Settings

This extension contributes the following settings:

  • markdownAdmonitions.enable: Enable/disable this extension.
  • markdownAdmonitions.mode: Set to what kinds of admonitions to render.

Known Issues

None.

About

VSCode extension to show markdown admonitions, Docusaurus style.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages