Zap Documentation

Markdown


This software application recognises only a limited set of markdown constructs in order to avoid surprises. These usually occur if you enclude computer code or extraneous punctuation in your posts. Usage of the preview function before submitting a post or comment is encouraged.

Bold and italic


Bold and italic are only recognised at the beginning of a line or after white space.
If you wish to include the special characters ( * or _ ) without interpreting them as markdown, precede them with a backslash '\' character or wrap the desired text in [nomd]*text to be escaped*[/nomd] tags.




MarkdownResult
*italic text* italic text
_italic text_ italic text
**bold text** bold text
__bold text__ bold text
***bold and italic text*** bold and italic text
___bold and italic text___ bold and italic text


Headers


Level headers must occur at the beginning of a line and be separated from the header text by at least one whitescape character. The exact rendering is dependent on the installed theme used and some different level headers may appear to be the same size and may include underlines or other text decoration.



MarkdownResult
Headline text
===========

Headline text

# level 1 header

level 1 header

## level 2 header

level 2 header

### level 3 header

level 3 header

#### level 4 header

level 4 header

##### level 5 header
level 5 header


Code and quotes


The markdown specification allows code blocks to be any line beginning with 4 spaces or a tab. This particular syntax rule may produce undesirable results with normal text that wasn't intended to be part of a code block and is not supported in this application. Additionally, inline code must be preceded by at least one space character or occur at the beginning of a line and may not include line breaks. If you wish to insert backtick characters without triggering a code block, precede them with a backslash character or wrap the text in [nomd][/nomd].




MarkdownResult
```
This is a code block
spanning multiple lines
```
This is a code block
spanning multiple lines
This is an example of `inline code`.
This is an example of inline code.
> This is quoted text which may
> span multiple lines.

This is quoted text which may
span multiple lines.




Links and images




MarkdownResult
[This is a hyperlink](https://freetobe.social) This is a hyperlink
![This is an image](https://freetobe.social/images/zot-300.png)




Lists


As with bold and italic, the first character of an unordered list may be preceded by a backslash or wrapped in [nomd][/nomd] tags to prevent normal text lines beginning with these characters from being interpreted as a list.




MarkdownResult
* list item 1
* list item 2
* list item 3

  • list item 1

  • list item 2

  • list item 3

- list item 1
- list item 2
- list item 3

  • list item 1

  • list item 2

  • list item 3

+ list item 1
+ list item 2
+ list item 3

  • list item 1

  • list item 2

  • list item 3

1. list item 1
2. list item 2
3. list item 3

  1. list item 1

  2. list item 2

  3. list item 3

1) list item 1
2) list item 2
3) list item 3

  1. list item 1

  2. list item 2

  3. list item 3