Use Admonitions on website
See original GitHub issue🚀 Feature Proposal
Our current docs are full of “Note:” and its ilk, sometimes as a quote (>
), sometimes in italics etc… We should instead use admonitions both since they look better, but also to have a consistent way of adding this type of info and it can differentiate between notes, tips etc…
Issue Analytics
- State:
- Created 2 years ago
- Comments:23 (14 by maintainers)
Top Results From Across the Web
Admonitions - Material for MkDocs
Admonitions, also known as call-outs, are an excellent choice for including side content without significantly interrupting the document flow. Material for ...
Read more >Admonition Styles (HTML) - Paligo
Paligo has several admonitions that you can use in your content, including note, warning, danger, important, and tip. Each admonition has ...
Read more >Admonitions: Tip, Note, Warning, See also, etc
The following directives are called Admonitions. You can use them to point out additional or important information.
Read more >Admonitions - NewbieDOC: Debian newbie documentation
Admonitions are used to draw attention to a specific subject. · Depending on what stylesheet you use to render your document you may...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@Biki-das you should had asked before opening a PR since I had claimed the issue beforehand,I was going though changes
Ok then,I will work on versioned doc,Np:)