Getting started with Asciidoctor
summary
Asciidoctor on the JVM converts asciidoc to HTML5/PDF/epub using Gradle and Maven plugins (Gradle plugin 1.5.3, Maven 1.5.2 examples shown), includes live source with the include macro with tag-based extraction (line ranges, tags, indentation and callouts keep snippets in sync), generates diagrams via JRuby + asciidoctor-diagram and PlantUML, and plugs into javadoc with asciidoclet; demos build and render automatically, and the extension API lets projects programmatically transform documents.
AI-written summary · about
chapters (17)
- 0:00Start
- 0:26Getting Started with Asciidoctor
- 4:23Markdown
- 7:45Sample Project
- 10:01Basics
- 10:34Metadata
- 13:33Table of Contents
- 14:54Technical Documentation
- 16:53Include Macro
- 17:33Variables
- 20:00Range
- 22:16Simple Comments
- 40:40Diagrams
- 41:37Asciidoctor Diagram Extension
- 42:13Use Ruby in the Jvm
- 42:40Set Up the Gems
- 49:48But There Is One Last Thing That I Would Like To Say Quickly I CanNot Show Longer the Example but I Said that We Have Variables We Have Conditionals We Also Have a Possibility of Extending the Tool if There Is a Tag or There Is a Feature That Is Not Provided by the Core Asciidoctor You Can Extend this Not Just with Ruby You Can Extend It with any Jvm Language through the Usage of the Asciidoctor Extension Mechanism and this Is Only Possible because Asciidoctor Builds an Ast of Your Document It Will Much Allows You To Program Documentation and that's Exactly What I Love this Thing because Instead of Just Writing Documents
related talks
46mAsciidoctor: because writing docs does not have to suck
47mSpice Up Asciidoctor Documentation With Java
29mAsciidoctor: New, Noteworthy, and Beyond
25mDocumentation as Code, Where to Start?
41mStop making fool of yourself about documentation
01h 00mLevels of Docs as Code
50mContinuous and Automated Documentation Docs As Code in Practice
47mDocumentation as code (explained to my dad)