Documenter.jl: List "admonition-like" syntax

Created on 26 Feb 2019  路  4Comments  路  Source: JuliaDocs/Documenter.jl

image

Although it is clear that there is support for Admonition-like syntax, this does not seem to be listed somewhere in the documentation :

I think you should list (a) which admonition-like blocks are possible (I assume only note and warning) and (b), for newcomers, how to actually use the syntax?

I know that we can just see it by clicking "edit on GitHub", but I still don't know which syntaxes are available.

Documentation

All 4 comments

They are actually documented in the Base manual: https://docs.julialang.org/en/v1/stdlib/Markdown/#Admonitions-1

Ah didn't know this. Of course you could say that this is just Markdown-specific and not just documenter specific, but still mentioning this and sharing the link could be helpful.

Do you think https://github.com/JuliaDocs/Documenter.jl/pull/985/files#diff-1842511d55effdf48dacc8c5de700712 would be enough?

yeap! Only thing I would add is after the word syntax is a parenthesis: (like how to use Admonitions)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

juliohm picture juliohm  路  6Comments

Roger-luo picture Roger-luo  路  3Comments

carlobaldassi picture carlobaldassi  路  5Comments

BioTurboNick picture BioTurboNick  路  5Comments

timholy picture timholy  路  6Comments