Manual documentation is dead. Long live automated documentation!
summary
Ank is a Gradle plugin that compiles and evaluates Kotlin and Java snippets at build time, verifies examples, and generates Markdown used directly on GitHub Pages. It is built on ank and arrow, offers modifiers such as replace modifier and outfile modifier plus a silent modifier, integrates into CI to fail builds when docs break, reports compiler errors with file and location, has known Kotlin script engine slowdowns and incomplete Android support, and can emit Try Kotlin/Dokka boilerplate for live playgrounds.
AI-written summary · about
chapters (8)
- 0:00Introduction
- 1:11What is Ankh
- 5:13Live demo of Ankh
- 16:48Setting up Ankh
- 19:21Known limitations
- 23:06Performance and future
- 27:47Future of Ankh
- 34:11Conclusion and call to action
related talks
44mPushing documentation (so it doesn't hurt anymore)
37mCode the documentation instead of documenting the code
39mKotlinify your Gradle
46mAsciidoctor: because writing docs does not have to suck
46mKotlin: MAX PAYNE
19mAutomate what you repeat: From boilerplate to automation
50mContinuous and Automated Documentation Docs As Code in Practice
22mIntegrating Kotlin Code into the Gradle Build Process