Skip to content

Instantly share code, notes, and snippets.

@nawroth

nawroth/DocGist Example.adoc

Last active November 23, 2018 09:40
Show Gist options
  • Save nawroth/5897167 to your computer and use it in GitHub Desktop.
Save nawroth/5897167 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
DocGist Example.adoc

DocGist Example

DocGist is a tool that renders AsciiDoc documents fetched from GitHub gists or other sources. The rendering is performed in the browser using the asciidoctor.js library. The original use case for this was http://gist.neo4j.org/ which has additional features to create examples for the Neo4j graph database.

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 with others so they can read the page.

Tips and tricks

Links to other DocGists can use this syntax: DocGist intro which renders as DocGist intro. This makes things easier in case you run DocGist locally to fiddle with the ``backend'' (it’s a frontend really).

You can view the source Gist of this page by clicking on the green button in the navbar.

How about some UML? This image is included by using image::http://yuml.me/c9ce39b0.png[] — yUML is tool for creating UML diagrams online.

c9ce39b0

Note that inline images are not supported yet. (There’s a bugfix for that, it will propagate here in some time.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment