Skip to content

gh-admonitions

Render GitHub-style alerts as admonitions. Native support was added in Zensical 0.0.67.

Reuse a GitHub README in documentation; distinguish tips and warnings in a migration guide.

Try it

Open the gh-admonitions example.

Tip

The GitHub-style TIP block renders as an admonition.

Warning

The WARNING block shows a second alert type using README-compatible syntax.

Source and configuration

The configuration and example Markdown are available in the repository. Other files in that directory supply the example’s fixtures.

Zensical compatibility and settings · Plugin documentation