Post

Writing Developer Notes with AsciiDoc

Markdown is great, but AsciiDoc won me over for internal tech notes.

  • Rich formatting with minimal effort
  • Native callouts, includes, and table support
  • Integrates beautifully with Spring REST Docs

Here’s a sample:

1
2
3
4
5
6
7
= My API Guide
Shiv Bade <shiv@byteco.de>

== Authentication

include::auth.adoc[]

It made documenting API behavior far more maintainable.

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