This file defines the conventions we use for material published at docs.nginx.com, concentrating on Markdown syntax.
To indicate a heading, place one or more hash symbols (
# ) at the start of the line, followed by one space and the title. The number of
# symbols corresponds to the HTML `<hX’> tag:
It is generally pointless to use headings at level 5 or higher; their formatting cannot be distinguished from regular text.
- There can be only one
<h1>level heading (single hash symbol) in a file, on the first line. This heading is the article title that appears in the left navigation bar on docs.nginx.com. If there is another
#heading, the content below it is ignored.
- Be sure to put a space between the hash symbols and the title:
## Configuring High Availability
##Configuring High Availability
- You can use bold and
monospaceformatting in a heading, though the former doesn’t always change the appearance.
To wrap some text with HTML comment syntax use
<!-- some text --> . The restriction is you are not allowed to use this comment syntax for multiline. If you need to comment out multiple lines then use separate comment tag for each line.
HTML character entities were breaking the words and making new paragraph.
Now you can use html character entities like
You are allowed to use following entities. If you need any new item, tell the NGINX web team.
We are unable to use Markdown table syntax. We use reStructuredText (reST) syntax. To use rST in Markdown, use a code block with the
reST code here ```
rST table syntax:
There are several ways to format tables using rST. List table is the recommended format. See the docutils documentation for more information: http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table
.. list-table:: Frozen Delights! :widths: 15 10 30 :header-rows: 1 * - Treat - Quantity - Description * - Albatross - 2.99 - On a stick! * - Crunchy Frog - 1.49 - If we took the bones out, it wouldn't be crunchy, now would it? * - Gannet Ripple - 1.99 - On a stick!
- See the RecommonMark Auto-Structify docs.
- Put code inside two sets of triple backticks (/```)
- After first backtick, write the name of code language. You can find all supported code language names here: http://pygments.org/docs/lexers/
- For nginx configuration codes set
nginxas the code block language. Example: ```nginx