https://github.com/madmas/asciidoctorgradle-doc2life

Living Documentation with Asciidoctor & Gradle - Slides & Examples
https://github.com/madmas/asciidoctorgradle-doc2life

asciidoctor demo devoxx documentation living-documentation spock talk

Last synced: about 1 month ago
JSON representation

Living Documentation with Asciidoctor & Gradle - Slides & Examples

• Host: GitHub
• URL: https://github.com/madmas/asciidoctorgradle-doc2life
• Owner: madmas
• Created: 2015-04-14T11:21:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-15T13:00:53.000Z (about 7 years ago)
• Last Synced: 2024-05-02T00:21:13.684Z (8 months ago)
• Topics: asciidoctor, demo, devoxx, documentation, living-documentation, spock, talk
• Homepage:
• Size: 10.9 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
=  Living documentation with Asciidoctor and Gradle

Markus Schlichting 

== Presentation

Please find the presentation slides at https://github.com/madmas/AsciidoctorGradle-Doc2Life/raw/master/presentation/Slides_DevoxxMA2017.pdf[presentation/Slides_DevoxxMA2017.pdf]

== Examples

The examples are accessible via the branches within this repository:

|===

|branch name | description

|master

| first example, showing the basic gradle build generating HTML and PDF from `src/doc/main.adoc`, demonstrating AsciiDoctor syntax and base features

|includeByLine

| demonstrate including a code snippet via reference by line numbers

|includeByLabel

| demonstrate including a code snippet via reference by tag

|variables

| demonstrate passing the version number from the build into the generated document

|livingDoc

| demonstrate using a CSV a source for data driven tests and the generated documentation at the same time

|===

== Resources

Some interesting links:

http://danhyun.github.io/asciidoctor-gradle-examples/[asciidoctor-gradle-examples]

http://mojavelinux.github.io/decks/discover-zen-writing-asciidoc/cojugs201305/index.html[Discover the zen of writing AsciiDoc]

http://mojavelinux.github.io/decks/asciidoc-with-pleasure/[AsciiDoc with pleasure]

http://mgreau.com/slides/websocket-asciidoctor/DevNation2014/slides.html[When WebSockets meet AsciiDoctor]

http://www.slideshare.net/aalmiray/devoxx-asciidoctor-tips[Asciidoctor Tips from Devoxx 2014]

http://mrhaki.blogspot.ch[MrHaki's Blog with regular posts on AsciiDoctor]

https://github.com/pledbrook/practical-groovy-public[Peter Ledbrook: 'Practical Groovy']

https://github.com/melix/gradlesummit2016-jigsaw-gradle/tree/master/slides[Slides with AsciiDoctor & Gradle by Cédric Champeau]

Devoxx 2017::

    https://www.youtube.com/watch?v=ggBv_pZDu0c[Hubert Sablonnière: Documentation as Code (explained to my dad)]

+

https://www.youtube.com/watch?v=T7RVT2_ntRU[Asciidoctor: New, Noteworthy, and Beyond by Alex Soto]