Document macros that are supported in Markdown plugin documentation
Commit 795167c05e60a0c0ba7b5edb00bab85b9d5b104e added support for
macros in the Markdown documentation of a plugin. This feature and the
supported macros were only described in the commit message. Add this
information to the official plugin documentation.
Change-Id: Ie7fcb783015f7667d8ec1c8f869c8f0b5e89e604
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt
index 7832aa9..07ce886 100644
--- a/Documentation/dev-plugins.txt
+++ b/Documentation/dev-plugins.txt
@@ -260,6 +260,27 @@
if the file name ends with `.md`. Gerrit will automatically convert
Markdown to HTML if accessed with extension `.html`.
+Within the Markdown documentation files macros can be used that allow
+to write documentation with reasonably accurate examples that adjust
+automatically based on the installation.
+
+The following macros are supported:
+
+[width="40%",options="header"]
+|===================================================
+|Macro | Replacement
+|@PLUGIN@ | name of the plugin
+|@URL@ | Gerrit Web URL
+|@SSH_HOST@ | SSH Host
+|@SSH_PORT@ | SSH Port
+|===================================================
+
+The macros will be replaced when the documentation files are rendered
+from Markdown to HTML.
+
+Macros that start with `\` such as `\@KEEP@` will render as `@KEEP@`
+even if there is an expansion for `KEEP` in the future.
+
Automatic Index
~~~~~~~~~~~~~~~
