Open graphitefriction opened 10 years ago
Thanks in advance.
We are writing the documentation now, totally in process. But we have a custom template, custom look&feel and all together working in Continuous Integration.
Regards,
Excellent! Then it will be a great example for the extent to which the output can be customized. I love it!
Absolutely!
TomEE refcard: http://tomee.apache.org/refcard/refcard.html
HiveMQ User Guide: hivemq.com/docs/hivemq/latest HiveMQ Plugin Documentation: http://www.hivemq.com/docs/plugins/2.0.1/
Hibernate website uses Asciidoctor for most pages http://hibernate.org.
Hibernate OGM, Hibernate Validator, Hibernate Search use Asciidoctor for their documentation. They use the Maven plugin and wire it to the docbook backend while keeping the documentation in Asciidoc for faster editing.
Hibernate ORM uses Asciidoc for its topical guides
Under the books category:
JavaMoney specification: https://github.com/JavaMoney/jsr354-api/blob/master/src/main/asciidoc/JavaMoneySpecification.adoc
Hibersap project: http://hibersap.org
PsyToolkit - www.psytoolkit.org
Taiga - http://taigaio.github.io/taiga-doc/dist/ (includes a custom HTML5 backend with an offcanvas navigation menu; source: https://github.com/taigaio/taiga-doc)
AjaxAnywhere - http://ajaxanywhere.com/documentation.html
opendaylight - https://github.com/opendaylight/docs
They are using AsciiDoc to DocBook to generate the web help format.
We should organize this list into books, software projects and perhaps other categories.
Eclipse Scout. For details, see https://www.bsi-software.com/scout/documentation-platform/
Another list can be found here: https://github.com/bodiam/awesome-asciidoc
Apache HBase Reference Guide: https://hbase.apache.org/book.html
Java for Kids: http://yfain.github.io/Java4Kids/
arc42, software architecture - http://arc42.github.io/
GroovyFX - http://groovyfx.org/docs/index.html Weld - https://github.com/weld/core/tree/master/docs/reference/src/main/asciidoc (uses DocBook toolchain to build final output from Asciidoctror-generated DocBook)
I've sorted them into the following groups.
@mojavelinux Should I sort out Docs into websites and specs? Or are there better groupings?
Authors and Publishers
Services
Websites
Docs
Specifications
Also, I need a status update on the following two:
Wireframe 1
Note: This is a wireframe, that's why there are gray boxes around the components. It's not a hi-fi mockup.
Note: The highlighted service, docs project, book, etc would change with each visit (i.e. we'd rotate them through a script <- but I don't mean via carousels, carousels are dirty :hankey: )
Fantastic!!
I think it's good to have the specs be a separate category because it sends a strong message. Though, this category may evolve overtime to be something more general (for instance, it could incorporate documents in other enterprises like legal).
We'll probably want to sort the Docs category by how well the entries serve as an example so people discover the ones first that show Asciidoctor in the best light. We'll also need to think about how best to handle the Spring entries since it encompasses many great examples of Asciidoctor in action.
Alt form of Wireframe 1
Somethings a little "meh" about the spacing in this one, but it could work because the "mores" in each category (like books) would only be a few, but for docs, there'd be a lot listed....hmmmmm
Maybe what it is missing is big, centered section headings like THE DOCS! THE BOOKS! THE SERVICES! THE JAZZ HANDS!
Keep in mind, we could use an accordion to reveal the “more” list. We could even use one of those partially shown accordions like you see on news site (we hate them there, but here it would actually make sense).
The CometD Documentation.
Manning has started taking Asciidoc now. Arquillian in Action will be done with Asciidoc, Docker in Practice is done in Asciidoc.
www.jboss.org uses asciidoc
Found a full book in both Japanese and Chinese.
http://azu.github.io/promises-book/ http://liubin.github.io/promises-book/
A nice demonstration of UTF-8 support and perhaps a good test case for future changes and improvements.
Noteshare - http://noteshare.io (service)
Geb - http://www.gebish.org/manual/snapshot/ (project)
We're new happy users of Asciidoctor for Dandelion (http://dandelion.github.io/)
For example:
ClojureScript Unraveled (book)
output: http://funcool.github.io/clojurescript-unraveled/ source: https://github.com/funcool/clojurescript-unraveled
The Eclipse Foundation is using Asciidoctor: https://waynebeaton.wordpress.com/2015/08/10/new-eclipse-project-handbook/ https://waynebeaton.wordpress.com/2015/08/11/technology-behind-the-new-eclipse-project-handbook/
Frege (via GitBook.io) - http://dierk.gitbooks.io/fregegoodness/content/
Here's the repo for the Eclipse project websites: http://git.eclipse.org/c/www.eclipse.org/projects.git/tree/handbook/source
Roel Van Steenberghe on the asciidoctor mailing list has written his course materials with asciidoctor: Computerarchitectuur (in Dutch)
https://github.com/asciidoctor/asciidoclet/pull/49 creates a list of Asciidoclet-powered projects.
Update: The Projects Powered by AsciiDoclet page is now live.
Mastering Bitcoin - Unlocking Digital Cryptocurrencies - O'Reilly book -- source
Elasticsearch: The Definitive Guide
Also Include Issue #236