Documentation with any editor

Create beautiful documentation in the editor of your choice and organize your stuff in git and co

Christoph Stoettner

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

Documentation is often boring and timed out until it's completely finished. So editing in any editor or device is very important. I show you how to create great documentation and documents of a single source with Asciidoc and include configuration files. These can be automatically converted to html, pdf, wiki and so on. Even building presentation slides out of these sources is easy possible.

I hate doing documentation and copy&paste stuff from configuration files to wordprocessors or wikis. So I started with Asciidoc and convert my documentation with Jenkins. This includes parts of config files (updated on the fly) and doing screenshots during conversion. It's not hard and you end with great documents to share with team members, customers or on your blog. I rely on good and uptodate documentation in my daily business, so keeping it uptodate without manually copy it from A to B is highly important.

Download

Related

Embed

Share:

Tags