summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/styleguidemd/index.rst
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-07-26 12:45:10 -0400
committerDave Barach <openvpp@barachs.net>2018-07-26 18:34:47 +0000
commit06dcd45ff81e06bc8cf40ed487c0b2652d346a5a (patch)
tree71403f9d422c4e532b2871a66ab909bd6066b10b /docs/gettingstarted/writingdocs/styleguidemd/index.rst
parent1d65279ffecd0f540288187b94cb1a6b84a7a0c6 (diff)
Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/writingdocs/styleguidemd/index.rst')
-rw-r--r--docs/gettingstarted/writingdocs/styleguidemd/index.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/gettingstarted/writingdocs/styleguidemd/index.rst b/docs/gettingstarted/writingdocs/styleguidemd/index.rst
new file mode 100644
index 00000000000..5bafb4d1512
--- /dev/null
+++ b/docs/gettingstarted/writingdocs/styleguidemd/index.rst
@@ -0,0 +1,15 @@
+.. _styleguidemd:
+
+####################
+Markdown Style Guide
+####################
+
+Most of these documents are written using :ref:`styleguide` (rst), but pages can also be
+written in Markdown. This chapter describes some constructs used to write these documents.
+For a more detailed description of Markdown refer to `Markdown Wikipedia <https://en.wikipedia.org/wiki/Markdown>`_
+
+.. toctree::
+
+ styleguide.md
+ styleguide02.md
+ styleguide03.md