Documentation with any editor

Christoph Stoettner

Playlists: 'froscon2019' videos starting here / audio / related events

Creating documentation is often boring and needs a lot of copy&paste to update the different output formats. I'll show you my workflow creating textbased documentation with asciidoctor and convert it through a pipeline to html, pdf and some more formats.

Creating professional documentation with asciidoctor and some other opensource tools, using the editor of your choice. I create a pipeline (Jenkins or Gitlab CI/CD) to convert a simple ascii text to any documentation format. So when your project needs html that's fine, when your customer needs some PDF and you want to use your company logo that's nearly the same. You can create multiple outputs from one source, update screenshots automatically and still edit it on any of your devices or editors. Using a pipeline and containers after commiting to a version control system can be used on any operating system, or directly in the cloud. So there is nothing between you and your documentation.