Docs Menu
Docs Home
/
MongoDB Meta Documentation
/
MongoDB Documentation Style Guide
/
Markup Guidelines

Headings and Sections

Headings organize information into a hierarchy of sections. To set headings, add repeating characters below the heading text.

To learn more about headings, see the Sphinx documentation.

Heading Markup Rules

To avoid errors in your header markup syntax, stick to the following rules:

  • Don't skip heading levels. Heading level 3 can't come after heading level 1.

    Use
    Avoid
    ============
    Manage Users
    ============
    Create One New User
    -------------------
    Options
    ~~~~~~~
    ============
    Manage Users
    ============
    Create One New User
    ~~~~~~~~~~~~~~~~~~~

  • Make the underline as long as the text above it. If you use a source constant in the header, the underline must match the length of the resolved text.

    Use
    Avoid
    Create One New User
    -------------------
    Create One New User
    ----------------

    This example assumes the source constant {+db+} resolves to "Database".

    {+db+} Functions
    ------------------
    {+db+} Functions
    ---------------

Back

Table Directives

Next

Inline Markup