Consider suitable admonitions to add to RHEOS documentation?

JuliaRheology / RHEOS.jl

RHEOS - Open Source Rheology data analysis software

MIT License

40 stars 9 forks source link

Consider suitable admonitions to add to RHEOS documentation? #75

Closed moustachio-belvedere closed 4 years ago

moustachio-belvedere commented 4 years ago

I was browsing the Documenter.jl documentation again today, one nice feature is this, admonitions:

https://juliadocs.github.io/Documenter.jl/stable/showcase/#Basic-Markdown-1

Allows you to highlight areas where you need to exercise caution, or emphasise a useful tip. Might be worth considering. Not sure if this doable from within the notebooks but would certainly be feasible in other parts of the documentation (and all of the docs if we switch to Literate.jl).

moustachio-belvedere commented 4 years ago

This is not feasible right now on many of the doc pages generated from notebooks so will close for now. We can consider this again if/when we decide to transition to Literate.jl based documentation.