opendev/gerrit
Code Issues Proposed changes

Merge "Document macros that are supported in Markdown plugin documentation"

Browse Source
This commit is contained in:
Martin Fick
2012-07-16 15:22:10 -07:00
committed by gerrit code review
parent c00f00cfe2 c78777dcda
commit d2e7f03d1a
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/dev-plugins.txt
View File

@@ -266,6 +266,27 @@ link:http://daringfireball.net/projects/markdown/[Markdown] style
if the file name ends with `.md`. Gerrit will automatically convert if the file name ends with `.md`. Gerrit will automatically convert
Markdown to HTML if accessed with extension `.html`. 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 Automatic Index
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~