Markdown

The Juju docs use a modified version of the Github Flavored Markdown to compose the content of the docs. We've retained the majority of GFM, with the exception of "Username linking" and "Emoji", both of which are Github specific.

In addition to the removals, we've also create several new Markdown definitions to implement features required for the docs. These definitions are outlined below.

Notes, Warnings, Callouts, Admonishments

Callouts are used to notify the user of additional information or warn them of potential pitfalls. This will create a notifications resembling the following in the docs:

To implement this callout, use the following syntax:

!!! Note: If you want to get more information on what is actually happening, or to help resolve problems, you can add the `--show-log` switch to the juju command to get verbose output.

Foldouts

When a page contains a high volume of information that would otherwise require a table of contents, or similar method of quick navigation, a foldout can be used. This will create a collapsed header which, when clicked, will expand to display all the content below it.

^# Header
  Content can be multi-paragraphed and will be sent through the Markdown parser

  As long as content is continually indented under the header