STx Documentation Style Guide: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
=Classes= | =Classes= | ||
You can use the class <code>sourcelabel</code> to format such elements as | You can use the class <code>sourcelabel</code> to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples: | ||
<div class="sourcelabel">Usage:</div> |
Revision as of 10:26, 21 May 2014
This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation.
Classes
You can use the class sourcelabel
to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples:
Usage: