Skip to content

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

  1. Use one H1 per document.
  2. Match the H1 to the title field where practical.
  3. Use sentence case for headings unless a formal name requires title case.
  4. Use tables for structured data.
  5. Use numbered lists for ordered processes.
  6. Use bullets for unordered lists.
  7. Use fenced code blocks with a language identifier.
  8. Use relative links for internal references.
  9. 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.

Use relative links:

[Metadata Standard](Metadata-Standard.md)