-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(project): execute grails doc --init
Closes #10
- Loading branch information
1 parent
4f0119b
commit f65b185
Showing
3 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
introduction: Introduction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |