X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=README.adoc;h=cd6642498b3727233ef4ab65867ed7b8d3c4130e;hp=e95a116cafd769fccdc447786376dbc31ae58b71;hb=3254bfddb36115364e0e9ba0ef7977935d15722c;hpb=1ff5e4e80ebfdab700d14abbe18da65cbdbb147a diff --git a/README.adoc b/README.adoc index e95a116..cd66424 100644 --- a/README.adoc +++ b/README.adoc @@ -18,6 +18,7 @@ To simplify the documentation task, we keep all Documentation within this repository. It is possible to generate the docs without installing any additional Proxmox packages with: + make pve-doc-generator.mk make index To update the auto-generate API definitions use: @@ -96,6 +97,10 @@ below the title text: Level 3: ^^^^^^^^^^^^^^^^^^^^^^ Level 4 (bottom level): ++++++++++++++++++++++ +NOTE: Level 4 headings are currently not working for `manpage` outputs, you may +want to use `.SECTION' instead, which results in the same rendering, and this +level of Heading isn't displayed in any Index/TOC anyway. + Section titles should always be preceded by two empty lines. Each word in a title should be capitalized except for ``articles, coordinating conjunctions, prepositions, and the word to in infinitives unless they @@ -138,6 +143,24 @@ Bulleted lists should be created using the '*' symbol: * First level again +If you need to have other elements on the same level than a list element you +can do this with the '+' symbol: + +---- +. First level +.. Second level ++ +Anothe Sentence (or Block) on the continued second level. +. First level again +---- + +. First level +.. Second level ++ +Anothe Sentence (or Block) on the continued second level. + +. First level again + Labeled Lists ^^^^^^^^^^^^^ @@ -328,7 +351,7 @@ screenshots create layout problems. Copyright --------- -Copyright (C) 2016-2017 Proxmox Server Solutions Gmbh +Copyright (C) 2016-2019 Proxmox Server Solutions Gmbh Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or