Creating a documentation site for users with AsciiDoc and Antora
summary
Creates a versioned documentation site by assembling AsciiDoc + Antora content from multiple Git repositories and branches, converting modules and components into HTML, merging with a UI theme and producing a static output deployable to GitHub Pages or S3. Build runs from a playbook YAML and CI pipeline in seconds, supports a search index and theme extensions, and previews in IDEs via an IntelliJ plugin. Documentation can include tested code snippets pulled from source so examples stay correct.
AI-written summary · about
chapters (8)
- 0:00Introduction to user docs
- 3:59User search behavior explained
- 7:09AsciiDoc language overview
- 13:32Setting up Antora
- 20:37Demo of Antora in action
- 24:45Benefits of this approach
- 26:29Summary and tools recap
- 26:52Q&A session
related talks
44mPushing documentation (so it doesn't hurt anymore)
25mDocumentation as Code, Where to Start?
36mAgile documentation: A first class citizen
41mStop making fool of yourself about documentation
47mDocumentation as code (explained to my dad)
46mAsciidoctor: because writing docs does not have to suck
50mContinuous and Automated Documentation Docs As Code in Practice
36mBuilding Docs like Code: Continuous Integration for Documentation