Rundeck documentation
Switch branches/tags
Clone or download
Latest commit 4be3cc0 Dec 6, 2018

README.md

Building

Requires:

  • pandoc installed and in your PATH

Build procedure:

make

Ouput:

  • html english output

    en/dist/html/*

  • man english output

    en/dist/man/*

  • zip package

    dist/rundeck-docs-VERSION.zip

Writing links

When writing Markdown links between documents, instead of using relative paths and html file names, which might change in the future, you can use these syntaxes to link directly to the page based on its absolute file path;

Link to a page and specify the link text:

[My text][page:administration/configuration/system-properties.md]

Link to the same page. The link text will be set to the document title for that page:

[[page:administration/configuration/system-properties.md]]]

Use the exact file path/name as present in the language subdirectory. The previous links link to the /en/administration/configuration/system-properties.md file when generated in the en dir.

Either one is preferable to the normal [link](../../path/to/file.html).