Authoring Guide¶
Reference pages that double as template validation:
- Code Examples: seven languages, titles, line numbers, highlights, output.
- Mathematics: the supported LaTeX syntax and limitations.
- Components: admonitions, tabs, tables, diagrams.
Conventions¶
- One
#heading per page; file names in kebab-case (01-variables.md). - Folders have an
index.mdand appear innavinmkdocs.yml. - Put reusable source files in
examples/and include them with--8<-- "programming/hello.py".