summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <rsd@gnu.org>2016-02-19 09:33:55 -0500
committerrsiddharth <rsd@gnu.org>2016-02-19 09:33:55 -0500
commitc45dce3d54fd9b0ca56a6238c5bb0fa59dc3f575 (patch)
treef1957919900b9014222290d6089081f53863d785
parent8a09e3d58269e806e5ed1f24dfb8e3931bf531ba (diff)
README.rst: added `Commenting` sub-section.
under a new section `General`. Addresses issue #5
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index d74b6ba..0d8f506 100644
--- a/README.rst
+++ b/README.rst
@@ -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
------