docs/general/index.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

General
-------

Commenting
~~~~~~~~~~

The markdown files can have comments in the `following three formats`__::

  [comment]: <> (This is one type of comment.)
  [//]: <> (This is another type of comment.)
  [//]: # (This is the third type of comment.)

The comments won't make it to the generated HTML.

.. _md_comments: https://stackoverflow.com/questions/4823468/comments-in-markdown
__ md_comments_