Post

Using AsciiDoctor to Keep Docs Closer to Code

We adopted AsciiDoctor to keep developer docs versioned with the codebase.

Pros:

  • Works with GitHub rendering
  • Clean syntax, supports diagrams
  • Can generate HTML, PDF with theming

Snippet:

1
2
3
4
5
= My Service Design
Shivprasad Bade
:toc:
:icons: font

Good docs age well when versioned with your APIs.

This post is licensed under CC BY 4.0 by the author.