Changeset View
Changeset View
Standalone View
Standalone View
swh/web/tests/resources/contents/code/extensions/example.adoc
- This file was added.
[[docgist]] | |||||
= icon:pencil-square-o[] DocGist | |||||
DocGist is a URL proxy tool that converts http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc] documents fetched from Gists (http://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 https://github.com/asciidoctor/asciidoctor.js[Asciidoctor.js] JavaScript library. | |||||
DocGist can render documents located anywhere, as long as the host permits cross-domain access. | |||||
The DocGist project is found at https://github.com/asciidoctor/docgist where you can get the code, file issues and contribute. | |||||
[NOTE] | |||||
DocGist uses the https://github.com/asciidoctor/asciidoctor/releases/tag/v1.5.3[latest release (1.5.3)] of Asciidoctor. | |||||
If you want to use the syntax of older versions, add `:compat-mode:` to the document header or by setting it in the btn:[Attributes] menu. | |||||
There's more information on this in the link:./?github-asciidoctor%2Fasciidoctor.org%2F%2Fdocs%2Fmigration.adoc[migration guide]. | |||||
[[basic]] | |||||
== icon:play[] The basics | |||||
[[how-to-use]] | |||||
=== icon:map-o[] How to use | |||||
* Create/locate a gist on GitHub (or use a file in Dropbox). | |||||
** Write text using AsciiDoc syntax in it. | |||||
** Save it. | |||||
* Enter the URL (or id) of the gist in the form on top of this page and hit Enter on your keyboard. | |||||
* The page is rendered. | |||||
* Share the URL to the page with others so they can read it. | |||||
For other possible hosts that can store documents, see <<source-documents>>. | |||||
No newline at end of file |