search

asciidoctor / asciidoctor.org

:globe_with_meridians: Asciidoctor project site. Composed in AsciiDoc. Baked with Awestruct.
https://asciidoctor.org
Other
327 stars 806 forks source link

Create document about how AsciiDoc is rendered on GitHub #419

Open mojavelinux opened 9 years ago

mojavelinux commented 9 years ago

Create a document that explains how AsciiDoc is rendered on GitHub and what to expect. Not all features of AsciiDoc are available and sometimes the output differs due to GitHub's rendering pipeline. This page should set expectations.

It would also be good to mention how to get a better preview using DocGist and the like.

mojavelinux commented 9 years ago

A few salient points are mentioned in the following blog entry: http://asciidoctor.org/news/2014/02/04/github-asciidoctor-0.1.4-upgrade-5-things-to-know/