proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-15 13:07:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

README.adoc: add info about macro usage

Browse Source
This commit is contained in:
Dietmar Maurer 2016-01-06 17:58:58 +01:00
parent 98d7e09a20
commit 8e6e64116e
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.adoc
View File

@ -1,5 +1,6 @@
Proxmox VE Documentation Proxmox VE Documentation
======================== ========================
include::attributes.txt[]
What is this? What is this?
------------- -------------
@ -14,6 +15,17 @@ Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.ebup'). files, or ebook formats ('.ebup').
Common Macro definition in link:attributes.txt[]
------------------------------------------------
'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
consistency. For example, we defined a macro called `pve`, which
expands to "Proxmox VE". The plan is to add more such definitions for
terms which are used more than once.
NOTE: The github 'asciidoc' viewer does not expand those macros.
Autogenerated CLI Command Synopsis Autogenerated CLI Command Synopsis
---------------------------------- ----------------------------------