Skip to content

Commit

Permalink
docs(project): execute grails doc --init
Browse files Browse the repository at this point in the history
Closes #10
  • Loading branch information
martinschimak committed Mar 5, 2014
1 parent 4f0119b commit f65b185
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/docs/guide/introduction.gdoc
Original file line number Diff line number Diff line change
@@ -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]
1 change: 1 addition & 0 deletions src/docs/guide/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
introduction: Introduction
17 changes: 17 additions & 0 deletions src/docs/ref/Items/reference.gdoc
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f65b185

Please sign in to comment.