]> git.proxmox.com Git - pve-docs.git/blobdiff - README.adoc
totp: fix copy/paste mistake
[pve-docs.git] / README.adoc
index 43ce69f9d032571800d097c59aadce0db274c336..3d614e5750dc8efc5c65ebb28c7e0d93e7fef670 100644 (file)
@@ -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:
@@ -142,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 as a list element you
+can do this with the '+' symbol:
+
+----
+. First level
+.. Second level
++
+Another Sentence (or Block) on the continued second level.
+. First level again
+----
+
+. First level
+.. Second level
++
+Another Sentence (or Block) on the continued second level.
+
+. First level again
+
 Labeled Lists
 ^^^^^^^^^^^^^
 
@@ -214,10 +233,12 @@ characters, its content is formatted as listing.
 Use this for formatting file contents or command output.
 ----
 
-Specially highlighted 'notes', 'warnings' and 'important' information
-can be created by starting a paragraph with `NOTE:`, `WARNING:` or
+Specially highlighted 'tips', 'notes', 'warnings' and 'important' information
+can be created by starting a paragraph with `TIP`, `NOTE:`, `WARNING:` or
 `IMPORTANT:`:
 
+TIP: this is a tip
+
 NOTE: this is a note
 
 WARNING: this is warning
@@ -332,7 +353,7 @@ screenshots create layout problems.
 Copyright
 ---------
 
-Copyright (C) 2016-2017 Proxmox Server Solutions Gmbh
+Copyright (C) 2016-2021 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