Writing Developer Notes with AsciiDoc
Writing Developer Notes with AsciiDoc

Writing Developer Notes with AsciiDoc

Author
Shiv Bade
Tags
asciidoc
developer-experience
Published
April 22, 2015
Featured
Slug
Tweet
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:
= My API Guide Shiv Bade <shiv@byteco.de> == Authentication include::auth.adoc[]
It made documenting API behavior far more maintainable.