diff options
| -rw-r--r-- | docs/general/index.rst | 16 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/general/index.rst b/docs/general/index.rst new file mode 100644 index 0000000..6b56f63 --- /dev/null +++ b/docs/general/index.rst @@ -0,0 +1,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_ diff --git a/docs/index.rst b/docs/index.rst index e0f0f50..bbb6398 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,3 +9,4 @@ install/index schedule/index speakers/index + general/index |