Skip to content

Commit

Permalink
Add note about heading underlines
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley committed Nov 3, 2024
1 parent cfe13ce commit ff866fb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/contributing/contributing_docs_rst.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,9 @@ Mautic uses the following syntax for headings:
H6
^^^
When you're writing documentation, be sure to nest your headings correctly. This means that you should only use one H1 heading per page, and then nest your headings in the order shown above. This helps to keep the documentation consistent and easy to read.
When you're writing documentation, be sure to nest your headings correctly. This means that you should only use one H1 heading per page, and then nest your headings in the order shown. This helps to keep the documentation consistent and easy to read.

Also be sure to extend the underline to fit the length of the heading text. This is a requirement of RST syntax and helps to keep the documentation looking neat and tidy.

Linking to other pages
======================
Expand Down

0 comments on commit ff866fb

Please sign in to comment.