Style Guide
Definitions
Definition — I have defined this
- This is a clean and easy way
- To make maintainable CommonMark
- It’s supported everywhere
A - Single hyphen
B – Double hyphen
C — Triple hyphen
- What is a modern definition?
- It uses the colon in front, but there is no easy way to do line breaks. It’s weird about where it puts the first indent.
- Does it support bullets?
- I mean not really?
- There’s a line space above the top bullet
- Items like to be off by themselves.
Admonish
Note
General information or additional context.
Tip
A helpful suggestion or best practice.
Important
Key information that shouldn’t be missed.
Warning
Critical information that highlights a potential risk.
Caution
Information about potential issues that require caution.
Footnote
This is a footnote1.
Links
Theme Break
A Code block
I'm wondering
if this is
a way to get
transparent
inline monospace.
Reference
Markdown - mdBook Documentation
-
This text is the contents of the footnote, which will be rendered ↩