README.adoc

= Awesome-asciidoc :toc: :toc-placement!:

A curated list of Awesome Asciidoc

toc::[]

== Tools

A collection of AsciiDoc tools

• https://plugins.jetbrains.com/plugin/30142-asciidoc-pro/edit[AsciiDoc Pro] - up to date plugin to support AsciiDoc in IntelliJ and other Jetbrains products
• https://www.adoc-studio.app[adoc Studio - AsciiDoc for Mac, iPad & iPhone]
• https://asciidocalive.docswriter.com/[Asciidoc Alive] - An open-source web based AsciiDoc editor
• https://github.com/llaville/asciidoc-bootstrap-backend[AsciiDoc Bootstrap] - An AsciiDoc backend that renders the AsciiDoc source as HTML5 in the style of Bootstrap
• http://espadrine.github.io/AsciiDocBox/[AsciiDocBox] - A Web based AsciiDoc editor
• https://github.com/rahmanusta/AsciidocFX[AsciidocFX] - JavaFX based Asciidoc Editor
• https://github.com/asciidoctor/atom-asciidoc-preview[Atom Editor]
• https://github.com/asciidoctor/atom-language-asciidoc[Atom Language]
• https://github.com/asciidoctor/brackets-asciidoc-preview[Brackets Editor]
• https://github.com/asciidoctor/asciidoctor-chrome-extension[Chrome Extension]
• https://github.com/rmpestano/cukedoctor[Cukedoctor] - Cucumber meets AsciiDoc
• http://houqp.github.io/asciidoc-deckjs/[Deck.js]
• http://gist.asciidoctor.org/[DocGist] - AsciiDoc to HTML proxy
• https://github.com/l3nz/dockbooker[Dockbooker] - Create multi-format eBooks from the command line using Docker
• https://github.com/asciidoctor/asciidoctor-backends[DZSlides]
• https://dl.bintray.com/de-jcup/asciidoctoreditor[Eclipse Plugin]
• http://www.emacswiki.org/AsciiDoc[Emacs Plugin]
• https://github.com/asciidoctor/asciidoctor-firefox-addon[Firefox Addon]
• https://github.com/asciidoctor/asciidoctor-gradle-plugin[Gradle plugin]
• https://github.com/kenliu/grails-asciidoc[Grails]
• https://github.com/asciidoctor/jekyll-asciidoc[Jekyll]
• https://kbroman.org/knitr_knutshell/pages/asciidoc.html[Knitr]
• https://github.com/gsantner/markor[Markor] - Android text editor, supports AsciiDoc as of v2.11
• https://github.com/GeertjanWielenga/AsciidoctorJ4NB[NetBeans]
• http://gist.neo4j.org/[Graphgist] - Neo4j Graph viewer
• https://github.com/FooBarWidget/mizuho[Mizuho] - documentation formatting tool
• https://plugins.jetbrains.com/plugin/7391[IntelliJ Plugin]
• https://github.com/neo4j-contrib/asciidoc-slides[Neo4J]
• http://wildfly-mgreau.rhcloud.com/ad-editor/[Realtime Collaborative Asciidoc Editor] - http://mgreau.com/slides/websocket-asciidoctor/DevNation2014/slides.html[Slides]
• https://github.com/asciidoctor/asciidoctor-reveal.js[Reveal.js]
• https://github.com/chevdor/sql2asciidoc[SQL to AsciiDoc] - NodeJS database documentation generator
• https://github.com/asciidoctor/sublimetext-asciidoc[Sublime Text 3 Plugin]
• https://github.com/mattneub/AsciiDoc-TextMate-2.tmbundle[Better TextMate Bundle]
• https://github.com/zuckschwerdt/asciidoc.tmbundle[TextMate Bundle]
• https://bimlas.gitlab.io/tw5-asciidoctor/[TiddlyWiki plugin]
• http://www.compileonline.com/try_asciidoc_online.php[Try Asciidoc online]
• http://www.methods.co.nz/asciidoc/chunked/ape.html[Vim support]
• https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode[Visual Studio Code AsciiDoc extension]
• https://github.com/mariotoffia/goasciidoc[goasciidoc] - A open source tool to generate AsciiDoc from https://golang.org/[go] code files / projects

== Guides

A collection of guides written in AsciiDoc

• http://www.activiti.org/userguide/[Activity Guide] - (https://github.com/Activiti/Activiti/tree/master/userguide/src/en[Source])
• http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/[Elastic Search] - (https://github.com/elasticsearch/elasticsearch-definitive-guide[Source])
• http://dierk.github.io/FregeGoodness/html/index.html[Frege Goodness] - (https://github.com/Dierk/FregeGoodness[Source])
• http://golo-lang.org/documentation/2.0.0/index.html[Golo Lang] - (https://github.com/golo-lang/golo-lang/tree/master/doc[Source])
• http://gr8crm.github.io/[Gr8CRM] - Great Customer Relationship Management Plugins for the Grails Web Framework
• http://new.griffon-framework.org/guide/latest/index.html[Griffon] (https://github.com/griffon/griffon/tree/development/docs/griffon-guide/src/docs/asciidoc[Source])
• http://groovy-lang.org/semantics.html[Groovy] - (https://github.com/groovy/groovy-core/tree/master/src/spec/doc[Source])
• http://groovyfx.org/docs/index.html[Groovy FX] - Groovy binding for JavaFX 2.0.
• https://github.com/OpenNMS/opennms/tree/develop/opennms-doc/guide-admin/src/asciidoc/text/poller[OpenNMS]
• https://github.com/progit/progit2[Pro Git, Second Edition]
• https://github.com/learning-spring-boot/learning-spring-boot-code[Learning Spring Boot] - Book written in Asciidoc
• http://spring.io/guides[Spring Guides]
• https://github.com/spring-projects/spring-restdocs[Spring REST docs]
• http://spockframework.github.io/spock/docs/1.0/[Spockframework]

== Resources

Other resources, like cheatsheets, tutorials, etc.

• http://powerman.name/doc/asciidoc[AsciiDoc cheatsheet]
• http://rwinch.github.io/asciidoctor-gradle-examples/[AsciiDoctor Gradle Examples]
• http://mrhaki.blogspot.nl/search/label/Asciidoc[MrHaki AsciiDoc]
• https://github.com/neo4j-contrib/developer-resources[Neo4j Developer Documentation]
• https://www.adoc-studio.app/blog/asciidoc-guide[AsciiDoc Guide]
• https://www.adoc-studio.app/downloads/templates/asciidoc-cheat-sheet[One Pager - AsciiDoc Syntax Reference]

== Experiences

• https://speakerdeck.com/glaforge/behind-the-scenes-of-the-new-groovy-website-and-documentation[Groovy-lang.org] - Behind the scenes of the new Groovy website and documentation
• https://medium.com/@chacon/living-the-future-of-technical-writing-2f368bd0a272[Pro Git] - Living the Future of Technical Writing
• http://spring.io/blog/2013/12/13/spring-s-getting-started-guides-migrated-to-asciidoctor[Spring.io] - Spring's Getting Started Guides migrated to Asciidoctor
• http://jaxenter.com/asciidoc-replacement-gets-further-fixes-2-106623.html[Jaxenter] - AsciiDoc replacement gets further fixes
• https://julien.danjou.info/blog/2014/making-of-the-hacker-guide-to-python[Hacker Guide to Python] - The Making of the Hacker Guide to Python
• https://phauer.com/2017/rest-api-documentation-swagger-asciidoc/[RESTful API Documentation with Swagger and AsciiDoc]
• https://medium.com/@flbenz/beautiful-api-documentation-with-negligible-overhead-2ba523205f61[Beautiful API documentation with negligible overhead]