Is it possible to display asciidoc document on github?

Is it possible to display an asciidoc file on github the same way I can now view a file with a tag? According to this blog post , I should be able to do this:

If you are interested in using AsciiDoc, go to GitHub and create a new file in one of your repos or gists using the .asciidoc or .adoc file extension.

However, I tried to do this and it didn't work. Can anyone tell me how to get an asciidoc document to display nicely formatted text on Github?

Here is the doc I tried to check with Asciidoc. https://github.com/00krishna/proj_blog/blob/master/test.adoc

+3


source to share


1 answer


Your file is not syntactically valid (or rather, the line is treated as plain text).

Original file:

==This is a test
this is a test of using asciidoc

      

==

There is no space after ; I believe this is necessary.



Modified version that displays correctly:

== This is a test
this is a test of using asciidoc

      

See test.adoc

and test2.adoc

in this Gist .

The syntax for this Single Line Captions function is described in the Asciidoc User Guide , section 11.2 .

+7


source







All Articles