diff options
| author | Robert Göhler <github@ghlr.de> | 2019-11-24 16:23:44 +0100 |
|---|---|---|
| committer | Robert Göhler <github@ghlr.de> | 2019-11-24 21:13:46 +0100 |
| commit | 6a776ece0f3aaab4a06f6bbac06c82ed17d3d621 (patch) | |
| tree | 66fe6f56aae6bb9e49de8bfdce9e04120d802ace /docs/contributing/documentation.rst | |
| parent | d9c14434aba05d94a3503c675d9eb819dc5107aa (diff) | |
| download | vyos-documentation-6a776ece0f3aaab4a06f6bbac06c82ed17d3d621.tar.gz vyos-documentation-6a776ece0f3aaab4a06f6bbac06c82ed17d3d621.zip | |
contributing: add section to style guide
Diffstat (limited to 'docs/contributing/documentation.rst')
| -rw-r--r-- | docs/contributing/documentation.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 3f088455..c89be9d4 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -83,6 +83,33 @@ This requires you already have a GitHub account. Style Guide ----------- +Sections +^^^^^^^^ + +We use the following syntax for Headlines. + +.. code-block:: sh + + ##### + Parts + ##### + + ******** + Chapters + ******** + + Sections + ======== + + Subsections + ----------- + + Subsubsections + ^^^^^^^^^^^^^^ + + Paragraphs + """""""""" + Address space ^^^^^^^^^^^^^ |