From f65b185653c7576e1e698d78079f749e123266ea Mon Sep 17 00:00:00 2001 From: Martin Schimak Date: Wed, 5 Mar 2014 19:06:05 +0100 Subject: [PATCH] docs(project): execute grails doc --init Closes #10 --- src/docs/guide/introduction.gdoc | 13 +++++++++++++ src/docs/guide/toc.yml | 1 + src/docs/ref/Items/reference.gdoc | 17 +++++++++++++++++ 3 files changed, 31 insertions(+) create mode 100644 src/docs/guide/introduction.gdoc create mode 100644 src/docs/guide/toc.yml create mode 100644 src/docs/ref/Items/reference.gdoc diff --git a/src/docs/guide/introduction.gdoc b/src/docs/guide/introduction.gdoc new file mode 100644 index 0000000..8b8166f --- /dev/null +++ b/src/docs/guide/introduction.gdoc @@ -0,0 +1,13 @@ +This is an example documentation template. The syntax format is similar to "Textile":http://textile.thresholdstate.com/. + +You can apply formatting such as *bold*, _italic_ and @code@. Bullets are possible too: + +* Bullet 1 +* Bullet 2 + +As well as numbered lists: + +# Number 1 +# Number 2 + +The documentation also handles links to [guide items|guide:introduction] as well as [reference|items] diff --git a/src/docs/guide/toc.yml b/src/docs/guide/toc.yml new file mode 100644 index 0000000..973dcf4 --- /dev/null +++ b/src/docs/guide/toc.yml @@ -0,0 +1 @@ +introduction: Introduction diff --git a/src/docs/ref/Items/reference.gdoc b/src/docs/ref/Items/reference.gdoc new file mode 100644 index 0000000..6be2c41 --- /dev/null +++ b/src/docs/ref/Items/reference.gdoc @@ -0,0 +1,17 @@ +h1. example + +h2. Purpose + +This is an example reference item. + +h2. Examples + +You can use code snippets: + +{code} +def example = new Example() +{code} + +h2. Description + +And provide a detailed description