This plugin serves project documentation as HTML pages.

If projects contain documentation, e.g. as Markdown files, the plugin automatically serves the generated HTML under /@PLUGIN@/project/<project-name>/<file-name>. The project name and the file name must be URL encoded.

The file is served from the branch/commit to which HEAD points unless a revision is specified in the URL as /@PLUGIN@/project/<project-name>/rev/<rev>/<file-name>.

  /@PLUGIN@/project/external%2Fopenssl/rev/stable-1.3/docs%2Ffaq.md

rev can be any ref or commit that is visible to the calling user.

If the file name is omitted, by default the plugin serves the README.md from the project if available.

By setting the URL parameter raw the document will be returned as raw unformatted text.

  /@PLUGIN@/project/external%2Fopenssl/rev/stable-1.3/docs%2Ffaq.md?raw

The raw parameter cannot be used for binary files.

WARNING: By default inline HTML blocks as well as inline HTML tags may be suppressed by formatters. If suppressed both will be accepted in the input but not be contained in the output.

Images that are stored in the project can be included into the project documentation, but they are only rendered if the image mimetype is configured as a safe mimetype.

The plugin includes several formatters for rendering documentation.