DocGist is a URL proxy tool that converts AsciiDoc documents fetched from Gists (https://gist.github.com), GitHub repositories, Dropbox folders and other sources to HTML. The conversion to HTML is performed in the browser (client-side) using the Asciidoctor.js JavaScript library
Note
|
DocGist is a hosted alternative to the Asciidoctor.js Live Preview extension for Chrome. |
See it live at https://gist.asciidoctor.org.
To run DocGist locally, make it available somewhere on localhost
.
First, check out the code:
git clone [email protected]:asciidoctor/docgist.git
cd docgist
With Ruby, you can then do something like this:
ruby -run -e httpd . -p 9090
With Python, there’s this:
python -m SimpleHTTPServer
If you have Apache httpd running on your machine, you can for example add a symlink along the lines of the following to make it serve DocGist:
sudo ln -s /home/anders/git/docgist /var/www/docgist
The above makes DocGist available at https://localhost/docgist/.
The original idea and code for DocGist came from GraphGist. GraphGist is an interactive documentation tool for the Neo4j database and Cypher query language. Both tools were created by Anders Nawroth, an engineer at Neo Technology.