Markdown Standard¶
| Field | Value |
|---|---|
| Reference | STD-002 |
| Type | Standard |
| Version | 1.00 |
| Status | Approved |
| Owner | Technical Lead |
| Approver | Board |
| Approval Record | |
| Effective Date | 2026-08-05 |
| Next Review | 2027-08-05 |
| Review Requirements | As defined in STD-001 |
| Classification | Internal |
Purpose¶
To define the Markdown conventions used within BRSA controlled documentation.
Scope¶
This standard applies to all Markdown documents maintained within BRSA repositories.
Markdown Format¶
Markdown is the authoritative source format for all controlled documents.
Generated outputs such as PDF or website content shall not be edited directly.
Headings¶
Documents shall use ATX headings (#).
Heading levels shall be used consistently and not skipped.
Lists¶
Bullet lists shall use -.
Numbered lists shall be used only where sequence is significant.
Tables¶
Tables shall be used where they improve readability.
Source formatting should prioritise content over visual alignment.
Links¶
Relative links shall be used for links between repository documents where practical.
External links should be used only where necessary.
Code Blocks¶
Code, commands and file paths shall be enclosed in fenced code blocks using triple backticks.
Related Documents¶
- STD-001 Document Standard
Review Requirements¶
As defined in STD-001.
Change History¶
| Version | Date | Author | Summary |
|---|---|---|---|
| 0.10 | YYYY-MM-DD | Initial draft | |
| 0.50 | 2026-07-24 | DC | Version -> 0.50; Status -> Review |
| 0.50 | 2026-08-05 | DC | Status -> Approved; Effective Date -> 2026-08-05; Last Reviewed -> 2026-08-05; Next Review -> 2027-08-05 |
| 1.00 | 2026-08-05 | DC | Version -> 1.00; Status -> Approved; Effective Date -> 2026-08-05; Last Reviewed -> 2026-08-05; Next Review -> 2027-08-05 |