aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-11-23 14:38:31 +0100
committerLoïc Hoguin <[email protected]>2016-11-23 14:38:31 +0100
commit6506afbce640d14ea772497839f45322cbdf0531 (patch)
treee7d84bf5592bcf318f01b342953fe7ba3726d3e7
parent9dd3ec20a0bb932c25ee4a766c4822471fe342cc (diff)
downloadasciideck-6506afbce640d14ea772497839f45322cbdf0531.tar.gz
asciideck-6506afbce640d14ea772497839f45322cbdf0531.tar.bz2
asciideck-6506afbce640d14ea772497839f45322cbdf0531.zip
Add syntax links to the README
-rw-r--r--README.asciidoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.asciidoc b/README.asciidoc
index 8e06e2c..337f47c 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -6,6 +6,16 @@ The `asciideck` project aims to provide a parser for Asciidoc
files returning an abstract syntax tree that can be further
manipulated or used to convert documents to different formats.
+== About Asciidoc
+
+The general Asciidoc syntax can be read in details from:
+
+* http://asciidoc.org/userguide.html
+* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
+
+Note that this project is a work in progress and everything is
+not available at this point.
+
== Getting help
* Official IRC Channel: #ninenines on irc.freenode.net