Documentation as Code with Antora

Antora is the multi-repository documentation site generator for tech writers who love writing in AsciiDoc. In this course, you will learn what is Antora, how to use it to document your software projects, and how to integrate it into your Documentation as Code strategy.

Course outline:

• Introduction
  • What is Documentation as Code?
  • The DevOps Documentation Lifecycle
  • Software documentation types
  • Choosing a markup language
  • Asciidoc primer
• Documentation as Code with Antora
  • Installing
  • Creating your first documentation website
  • The Antora YAML file
  • The Playbook YAML file
  • Components and modules
  • Antora extensions
• Creating Content with Antora
  • Navigation
  • Working with versions
  • Pages and image assets
  • Source code and attachments
  • DRY: includes and attributes
  • Embedding diagrams using Kroki
• Customizing the UI
  • Structure of the project
  • Customizing templates
  • CSS and JavaScript
  • Enabling STEM content
  • Customizing 404 pages
  • Adding a search engine
• Advanced Documentation as Code
  • Setting up pipelines: GitHub Actions and GitLab CI/CD
  • Renaming files and redirecting
  • Automated checks: syntax, grammar, style, etc
  • Adding Google Analytics support
  • Proofreading with Pull and Merge Requests
  • Generating other formats: PDF, EPUB, man pages
  • GitLab and GitHub Actions
  • Deploying documentation
• Conclusion

Cover photo composed with images by Sigmund and Gabriel Heinzer on Unsplash.