All documentation is within the code base and is written in MarkDown.
Markdown is a plain text formatting syntax designed so that it can be converted to HTML. There is no clearly defined Markdown standard but if you comply to the following syntax the generated pages should be formatted correctly.
Paragraphs and Breaks | |
---|---|
Markdown accepts text on consecutive lines as a hard-wrapped paragraph. Put a blank Line in between to start a new graph. |
Markdown accepts text on consecutive lines as a hard-wrapped paragraph. Put a blank Line in between to start a new graph. |
Headings | |
# Header 1 ## Header 2 ### Header 3 |
Header 1 Header 2 Header 3 |
Blockquote | |
> Blockquote. |
|
Lists | |
Start ordered list with number. 6. Ordered 7. List 8. Items Unordered list * Unordered * List * Item |
Unordered list
|
Links | |
An [inline link](http://www.google.com/ "optional title"). An [inline link to header page](#Site_Documentation) references header on current page. A [reference link][id]. [id] defined elsewhere [id]: <http://www.google.com/> (optional title) Linked URL: <http://www.google.com/> Mail to: <address@example.com> |
An inline link. An inline link to header page references header on current page. id defined elsewhere Linked URL: http://www.google.com/ Mail to: address@example.com |
Images | |
![Alternative title image](images/Uniknow-logo.jpg) |
|
Code | |
Inline `code` example. Preformatted code block: <strong>Just indent 4 spaces.</strong> Double-backticks (`` ` ``) delimit literal backticks |
Inline code example. Preformatted code block: <strong>Just indent 4 spaces.</strong> Double-backticks (`) delimit literal backticks |