Skip to content

Instantly share code, notes, and snippets.

@toastal

toastal/admonition.adoc

Last active October 8, 2021 04:23
Show Gist options
  • Save toastal/20e9d2d5ecc78d33028bbd870e6cdc67 to your computer and use it in GitHub Desktop.
Save toastal/20e9d2d5ecc78d33028bbd870e6cdc67 to your computer and use it in GitHub Desktop.
Download ZIP
Use Admonitions
Raw
admonition.adoc
Important
Use Admonitions

Admonitions are a better way to do callouts in documentations. Using > in Markdown in a blockquote and should be used for quotes. Markdown has many limitations and is very fragmented in its syntax leading to many competing flavors. AsciiDoc can remedy many of these shortcomings. GitLab and GitHub support AsciiDoc for markup rendering now. It’s a viable option with a few extra handy features you just can’t get with Markdown.

This is a blockquote and should be used for quoting other sources

IMPORTANT: you probably don’t mean to use these for admontions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment