diff options
| -rw-r--r-- | README.rst | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -240,6 +240,22 @@ speaker' name is "John Hacker", the ID for this speaker will be - The IDs are transliterated to ASCII; if a speaker' name is "John HÖcker", the ID for this speaker will be ``hacker``. +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_ Source ------ |