Documentation starter
Write a task-first guide, concept or reference and compare its HTML and Markdown forms.
Downloads
Start with the question your reader needs answered. Use a guide for one task, a concept for one explanation and a reference for a precise lookup. The starter includes those page templates, a chapter review checklist and an HTML/Markdown parity card.
Describe the same article in both forms
This is an implementation example of a canonical page and Markdown alternate, not a statement about a live site's headers:
<link rel="canonical" href="https://docs.ouros.md/docs/getting-started/fast-notes">
<link rel="alternate" type="text/markdown" href="https://docs.ouros.md/docs/getting-started/fast-notes.md">
Structured data should match the visible article. Use real titles, products and publishers; do not add an invented expert or fabricated review date.
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "Save your first note",
"url": "https://docs.ouros.md/docs/getting-started/fast-notes",
"about": {
"@type": "SoftwareApplication",
"name": "Ouros X"
},
"publisher": {
"@type": "Organization",
"name": "Ouros",
"url": "https://ouros.md/"
}
}
Attribute the synthesis
Use this block as a template, replacing the prompts with your actual sources and method:
## Sources and method
- Primary source: [CommonMark reference](https://commonmark.org/help/).
- Method: source-based synthesis with an original worked example.
- What we checked: list the source passages and any executed example.
- Limits: identify what was not tested.
This article shares what we learned; it is not the source publisher’s official documentation.
The starter is original material with outbound references. It does not bundle other companies' documentation. Compare both representations before publishing: required warnings, steps, code and links should remain useful without the visual layout.