Generiek

Dit bestand legt de generieke stijl- en opmaakkeuzes vast voor de Markdown-documentatie binnen .Docs.

Structuurregels

• Elke hoofdmap van een onderdeel bevat een readme.md als startpagina.
• Elke submap die als logisch instappunt dient, bevat ook een readme.md.
• Bestandsnamen zijn klein geschreven, gebruiken koppeltekens en beschrijven het onderwerp zo concreet mogelijk.
• Afbeeldingen staan altijd in een lokale submap images.

Navigatieregels

• Elke inhoudelijke pagina begint met een compact navigatieblok.
• Elke inhoudelijke pagina eindigt met een navigatieblok met waar relevant een link naar de vorige en volgende pagina.
• Readme-pagina's vormen instappunten; inhoudspagina's vormen de bladerstructuur.

Markdown-opmaak

• Gebruik ATX-headings (#, ##, ###).
• Gebruik tabellen alleen als de broninhoud tabelvormig is.
• Gebruik fenced code blocks met expliciete taal als die bekend is.
• Gebruik relatieve paden voor links en afbeeldingen.

Afbeeldingen

• Zet een afbeelding direct onder het stuk tekst waarnaar deze hoort.
• Voeg onder de afbeelding een kort figuurbijschrift toe in cursief.

Codeblokken

• Behoud oorspronkelijke inspringing en regelstructuur.
• Pas code niet stilzwijgend inhoudelijk aan bij omzetting.