diff --git a/site/documentation.html b/site/documentation.html index 3f4c271..1110b69 100644 --- a/site/documentation.html +++ b/site/documentation.html @@ -272,7 +272,7 @@ ... -####### This is a level 7 (smallest) header.
Text block
Important: This block cannot have child elements!
A text block is any block that is not prefixed by a special character. It is shown as defined, with inline markup applied.

Inline markup

There are also various forms of inline markup that you can use in your documentation.
Emphasized text
Emphasized text is typically displayed as italic. You can emphasize text by enclosing it in two asterisks on each side.
Example: Emphasizing text
Code:
This is just some text, and **this part is emphasized**.
Strong text
Strong text is typically displayed as bold. You can make text strong by enclosing it in two underscores on each side.
Example: Making text strong
Code:
This is just some text, __and this part is strong__.
Internal references (hyperlinks)
Internal references are hyperlinks that point to other documents in the same documentation set. Depending on the export format (currently only HTML is supported), the appropriate extension is automatically appended. The paths should resemble the directory structure you are storing the ZippyDoc source files in. The target of the reference is enclosed in curly braces and prefixed with a >. If you wish to give the reference a friendly description, you can do so by appending it, enclosed in parentheses.
Example: Referencing another documentation page
Code:
You can also view the API documentation at {>api/index}.
Example: Referencing another documentation page with a friendly description
Code:
You can also view the {>api/index}(API documentation).
External references (hyperlinks)
External references are hyperlinks just like the internal references, but they refer to an external resources. The syntax is identical to that of internal references, except for the > disappearing. Note that external references are only picked up when the text enclosed in the braces is an actual URI of some sort.
You can also force an external reference to be created by prefixing the URI with <. This is useful when you want to for example link to a download relative to the current page.
Example: Referencing Google
Code:
You could also search {http://www.google.com/}.
Example: Referencing another documentation page with a friendly description
Code:
You could also search {http://www.google.com/}(Google).
Example: Referencing a relative file that is not a ZippyDoc document
Code:
You can download it by {<file.zip}(clicking here).
Fixed-width text
Fixed-width text can be useful to indicate code elements or other things that would benefit from being displayed in a terminal-like font. You can make text fixed-width by enclosing it in backticks.
Example: Fixed-width text
Code:
Now enter `./run.sh` into your terminal.

Special tags

Currently there is only one special tag. Special tags can be inserted anywhere in the document to insert a generated element.
Table of contents
To insert a table of contents that is automatically generated from all definition blocks on the page, simply insert {TOC} on the page where you want it to appear (it has to be in its own paragraph). Typically you will want to place it just below the main page header.
Every item in a table of contents will be followed by a snippet of text, that is grabbed from the first Text block for that definition. Alternative notations are shown after this description.
Example: Including a table of contents
Code:
# Sample documentation
+####### This is a level 7 (smallest) header.
Text block
Important: This block cannot have child elements!
A text block is any block that is not prefixed by a special character. It is shown as defined, with inline markup applied.

Inline markup

There are also various forms of inline markup that you can use in your documentation.
Emphasized text
Emphasized text is typically displayed as italic. You can emphasize text by enclosing it in two asterisks on each side.
Example: Emphasizing text
Code:
This is just some text, and **this part is emphasized**.
Strong text
Strong text is typically displayed as bold. You can make text strong by enclosing it in two underscores on each side.
Example: Making text strong
Code:
This is just some text, __and this part is strong__.
Internal references (hyperlinks)
Internal references are hyperlinks that point to other documents in the same documentation set. Depending on the export format (currently only HTML is supported), the appropriate extension is automatically appended. The paths should resemble the directory structure you are storing the ZippyDoc source files in. The target of the reference is enclosed in curly braces and prefixed with a >. If you wish to give the reference a friendly description, you can do so by appending it, enclosed in parentheses.
Example: Referencing another documentation page
Code:
You can also view the API documentation at {>api/index}.
Example: Referencing another documentation page with a friendly description
Code:
You can also view the {>api/index}(API documentation).
External references (hyperlinks)
External references are hyperlinks just like the internal references, but they refer to an external resources. The syntax is identical to that of internal references, except for the > disappearing. Note that external references are only picked up when the text enclosed in the braces is an actual URI of some sort.
You can also force an external reference to be created by prefixing the URI with <. This is useful when you want to for example link to a download relative to the current page.
Example: Referencing Google
Code:
You could also search {http://www.google.com/}.
Example: Referencing Google with a friendly description
Code:
You could also search {http://www.google.com/}(Google).
Example: Referencing a relative file that is not a ZippyDoc document
Code:
You can download it by {<file.zip}(clicking here).
Fixed-width text
Fixed-width text can be useful to indicate code elements or other things that would benefit from being displayed in a terminal-like font. You can make text fixed-width by enclosing it in backticks.
Example: Fixed-width text
Code:
Now enter `./run.sh` into your terminal.

Special tags

Currently there is only one special tag. Special tags can be inserted anywhere in the document to insert a generated element.
Table of contents
To insert a table of contents that is automatically generated from all definition blocks on the page, simply insert {TOC} on the page where you want it to appear (it has to be in its own paragraph). Typically you will want to place it just below the main page header.
Every item in a table of contents will be followed by a snippet of text, that is grabbed from the first Text block for that definition. Alternative notations are shown after this description.
Example: Including a table of contents
Code:
# Sample documentation
 
 {TOC}