Roave / DocbookTool

Roave Docbook Tool Static HTML and PDF generator tool for generating documentation from Markdown files. • Generates a deployable HTML file from Markdown documentation • Generates PDF files of the same documentation that can be deployed alongside • Link pages to a Confluence instance so the content can be mirrored there Running with Docker A Docker image is provided with all the pre-built tools. You will need to map several volumes into the container: • - this will be where the tool writes the output • - the path containing the Markdown files to be rendered • - the and templates to use for rendering HTML/PDF respectively • - if you have features, this should contain your features Additionally, you can provide environment variables to override the default paths used, or to enable the Confluence functionality. Usage For example, this command would generate only the HTML documentation: Formatting We have limited support for YAML front matter: • - when specified, this will be used as the page title ( in template) • - when specified, a PDF will be generated for this • - when specified, Confluence page will be updated (numeric ID only) • - when specified, pages are ordered by this. Defaults to 100. Matching values are sorted alphabetically. Additionally, we have a special Markdown syntax: • will render as a code block • Code blocks (triple-backtick) with the syntax will be converted into a PlantUML diagram. Note your diagram must start and end with and respectively. • will render as a code block. Only is supported at the moment. Example showing all syntax can be seen in . Environment variables • - the path where your Markdown documentation is kept (Required) • Example: • - the path to your Twig templates called and (Required) • Example: • - the base path from where features are stored (Optional) • Example: • - where to generate the HTML documentation (Required, if using ) • Example: • - where to generate the PDF files, if used (Required, if using ) • Example: • - the base URL of confluence ( is appended to this, so don't include that) (Required, if using ) • Example: • - the header value to use (Required, if using in a non-interactive terminal). • Example using a personal access token (PAT): • Example using basic auth: • - Should the content hash check be skipped. Set to to skip the hash check. Note that this means every time the tool runs, the content will create a version in Confluence, even if nothing has changed. This is a workaround for some API issues with certain Confluence setups, so we don't recommend enabling this unless you have a specific need to. • Example: