Version 1 Release

Version 1.0.0

docs-toolchain is a Ruby based framework to build Asciidoctor content with additional features and checks.
A template for this build system can be found here wirecard/docs-template.

Build

The build is split into stages:

1. Test
2. Pre-processing
3. Build
4. Post-processing
5. Deploy (using a dedicated Github Actions Workflow)

Before the first use, the Setup stage has to be executed.

Features

• Asciidoctor content build
• Lunr search index #26
• Stages: #11, #12, #52
• Plugin system:
  • Extensions: #15, #19, #46
  • Pre/Post Processes: #81
    • HTML Test: #72, #84
• HTML5 Multipage Converter #57
• Custom Table of Content #74, #70
• Central Config Manager #32, #33
• Rakefile based #21

Roadmap

• Diagram support using TikZ #5
• Config Manager variable substitution #41
• download tag for links #65
• Slack Github Action #6