Login  Register

Read The Docs Integration

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options Options
Embed post
Permalink
Reply | Threaded
Open this post in threaded view
| More
Print post
Permalink

Read The Docs Integration

mojavelinux
Administrator
The Asciidoctor project is friends with many open source projects. One of those projects is Read The Docs (readthedocs.org). Read The Docs hosts documentation online and makes it searchable (usually sourced & built from content in GitHub repositories). The site was started and is maintained by fellow open source champion and friend Eric Holscher (http://ericholscher.com/about/)

Read The Docs currently hosts documentation composed in reStructuredText and Markdown. Eric has reached out to the Asciidoctor community with an offer to host AsciiDoc by integrating with Asciidoctor. This involves deciding on a recommended static site generator to build the docs and, of course, actually doing the integration. I'm leaning towards Dexy (http://dexy.it/) as the recommended tool since, like Read The Docs, it's Python-based and it has killer Asciidoctor integration.

The potential impact here is *huge* for AsciiDoc and Asciidoctor. In addition to GitHub, we can put AsciiDoc next to reStructuredText and Markdown on Read The Docs and show the world of authors *this* is the way to write. What the Read The Docs integration has over the GitHub integration is that we'll be able to use the full power of AsciiDoc, including includes!

If you are interested in this participating in this initiative, please chime in on the issue files in the Read The Docs GitHub repository.


Let's do this!