Markdown Standard¶
Why This Exists¶
This standard defines how Markdown must be used in the Algosure Blueprint repository.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
Consistent Markdown improves maintainability, review quality, rendered documentation, and long-term organizational memory.
Markdown Rules¶
- Use one H1 per document.
- Match the H1 to the
titlefield where practical. - Use sentence case for headings unless a formal name requires title case.
- Use tables for structured data.
- Use numbered lists for ordered processes.
- Use bullets for unordered lists.
- Use fenced code blocks with a language identifier.
- Use relative links for internal references.
- Avoid raw HTML unless Markdown cannot express the content.
Heading Structure¶
Use headings to show document structure, not visual emphasis.
# Document Title
## Section
### Subsection
Tables¶
Tables must have clear headers and concise cells.
| Column | Standard |
|---|---|
| Headers | Required. |
| Empty cells | Avoid unless the absence has meaning. |
Admonitions¶
Use admonitions sparingly for important notes.
!!! note
This is an important note.
Related Documents¶
Use relative links:
[Metadata Standard](Metadata-Standard.md)