Rules and conventions

Examples

title

Titles define the structure of a Mechdown document and drive generated navigation such as the table of contents.

Mechdown supports hierarchical titles:

  • Document title: the file's top heading

  • Section titles: numbered headings such as 1. Section

  • Subsection titles: headings such as (1.1) Subsection

  • Sub-subsection titles: headings such as (1.1.1) Topic

Rules and conventions

  • Use one document title per file. The document can have an optional byline (author, date, etc.) immediately following the title.

  • Keep section numbering sequential.

  • Keep subsection numbering aligned with the parent section.

  • Prefer short, descriptive titles so generated navigation remains readable.

Examples

Mechdown Title Guide
===============================================================================

1. Section Title
-------------------------------------------------------------------------------

(1.1) Subsection Title

(1.1.1) Sub-subsection Title

Section and first-level subsection titles are included in the generated table of contents.

To add a byline, place it immediately after the title and conclude with a second === separator:

My Document
===============================================================================
By Mika the Mech
===============================================================================