Formatting Guide#
The Brightway Documentation webpage, including the Example Gallery, uses the MyST markdown format. Markdown is a is a lightweight markup language (=text-encoding system) for creating formatted text using a plain-text editor. MyST is a dialect of Markdown that supports many visual elements useful in scientific publishing.
Formatting Features#
For instance, you can use plain text to write a LaTeX equation:
$y = mx^2 + b$
which will be rendered as:
\(y = mx^2 + b\)
You can also add page elements, such as colored information boxes:
:::
{note} This is an information box
:::
which will be rendered as:
Note
This is an information box
Other functions include cross-references, footnotes, embedded images, tables, colored information boxes and more. “If you can do it in Microsoft Word, you can do it in Markdown!” To provide this functionality in Jupyter Notebooks, the Brightway Documentation webpage uses the MyST-NB extension.
Reference#
For a complete overview of the MyST Markdown syntax, please refer to the MyST Markdown Guide. This will covery all cases you might want to use in your edits to the Brightway Documentation webpage: