Style Guide
Definitions
Headings use sentence case, it’s a touch more casual and less commanding
MPL — Modern Parking Lot
- Uses CommonMark
- Bold for the abbreviation, which is used in common speech
- Expansion goes next to it with a hyphen train
- Items go underneath as bullets
- Sort of resembles a parking lot
- Never has periods on the end
- Sentence case
- No periods on the end
A - Single hyphen, Nope
Two – hyphens, Nope
Hyphen Train — Uses three hyphens. Good. Don’t bold the definition
- This 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. It’s also like, very tightly spaced?
I guess this would be good for prose? Nope, doesn’t respect indents.
- Just bolds the whole thing
- 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.
SUMMARY.md
<-- Section should be a large inclusive word, because it will show up in the URIs -->
# Routing
<-- All files go into same same section folder -->
- [OSPFv2](./ospf/ospfv2.md) <-- Root -->
- [DR Election](./ospf/ospfv2-dr-election.md) <-- Sidebar_Branch_Title is short, branch_name_is_qualified -->
- [DR LSAs](./ospf/ospfv2-dr-lsas.md) <-- Sidebar_Leaf_Title is short, leaf_file_name_is_qualified -->
Footnote
This is a footnote1.
Links
Theme break
A code block
never use this
it can't be found
because its not fenced
A good numbered list
1. It needs to be bolded on the top
- It looks good
- Bold catches the eyes
2. Keep Numbering
- Everything will work out fine
A bad numbered list
- This doesn’t work.
- Nope
- Not at all
- Seems like it should
- But it doesn’t
Reference
Markdown - mdBook Documentation
-
This text is the contents of the footnote, which will be rendered ↩