opendev/gerrit
Code Issues Proposed changes

Clarify that documentation for plugins has to be in pegdown

Browse Source 
To avoid that plugin developers write documentation in the wrong
Markdown flavor, we make the used flavor explicit in the
documentation.

Change-Id: Id04c693294ba6dd396796a8c423a7d9c9890c18a
This commit is contained in:
Christian Aistleitner 2015-03-26 21:09:09 +01:00
parent b01b8721b2
commit 040cf8285a
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/dev-plugins.txt
View File

@ -1848,8 +1848,8 @@ will be available as `/plugins/helloworld/Documentation/resource`. This
prefix is configurable by setting the `Gerrit-HttpDocumentationPrefix` prefix is configurable by setting the `Gerrit-HttpDocumentationPrefix`
attribute. attribute.
Documentation may be written in Documentation may be written in the Markdown flavor
link:http://daringfireball.net/projects/markdown/[Markdown] style link:https://github.com/sirthias/pegdown[pegdown]
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`.