====== DokuWiki Syntax Cheatsheet ======

===== Text Formatting =====

^ Syntax ^ Rendered ^
| <nowiki>**bold**</nowiki> | **bold** |
| <nowiki>//italic//</nowiki> | //italic// |
| <nowiki>__underlined__</nowiki> | __underlined__ |
| <nowiki>''monospace''</nowiki> | ''monospace'' |
| <nowiki>**//bold italic//**</nowiki> | **//bold italic//** |
| <nowiki>~~strikethrough~~</nowiki> | ~~strikethrough~~ |

Double space in front can be used to render text as monospace. Good for ascii art:
           _ __    _
   _    __(_) /__ (_)
  | |/|/ / /  '_// /
  |__,__/_/_/\_\/_/
          
 


===== Headings =====

<code>
====== H1 ======
===== H2 =====
==== H3 ====
=== H4 ===
== H5 ==
</code>

===== Lists =====

<code>
  * Unordered item
    * Nested item

  - Ordered item
    - Nested item
</code>

Rendered:
  * Unordered item
    * Nested item

  - Ordered item
    - Nested item

===== Links =====

^ Syntax ^ Rendered ^
| <nowiki>[[start]]</nowiki> | [[start]] |
| <nowiki>[[start|Home]]</nowiki> | [[start|Home]] |
| <nowiki>[[https://freebsd.org|FreeBSD]]</nowiki> | [[https://freebsd.org|FreeBSD]] |

===== Code =====

<code>
''inline code''
</code>

Rendered: ''inline code''

<code>
<code bash>
service nginx reload
</code>
</code>

Rendered:
<code bash>
service nginx reload
</code>

===== Tables =====

<code>
^ Header 1  ^ Header 2  ^
| Cell 1    | Cell 2    |
| Cell 3    | Cell 4    |
</code>

Rendered:

^ Header 1  ^ Header 2  ^
| Cell 1    | Cell 2    |
| Cell 3    | Cell 4    |



===== Images =====

<code>
{{wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png|caption}}
{{wiki:dokuwiki-128.png?100}}
</code>

===== Namespaces =====

<code>
[[servers:sanctum]]
[[services:vaultwarden]]
</code>

Pages in namespaces show as red until created — that is normal.

===== References =====

<code>
Some text needing referencing((This is the footnote/reference text.))
Some more text((https://git.labunix.xyz accessed on: 2026-06-09))
</code>

Rendered as:

Some text needing referencing((This is the footnote/reference text.))
Some more text((https://git.labunix.xyz accessed on: 2026-06-09))
===== Images  =====

<code>
<WRAP right 200px>
{{root:labunix_log.png?200}}
some text to describe this
</WRAP>
</code>

rendered as the image to the right

<WRAP right 200px>
{{playground:favicon.svg?200}}
some text to describe this
</WRAP>

needs to be uploaded and reference the correct //page// to which it was uploaded

===== Comments =====

<code>
The text /* between the slash-asterisk and asterisk-slash */ is hidden
</code>

Rendered as: The text /* between the slash-asterisk and asterisk-slash */ is hidden

You can also have multi-line comments:
<code>
  /**
   * @todo: rewrite this section to reflect changes made recently
   *
   * this is a longer note
   */
</code>

But this single line example works too:
<code>
  /********** added by Esther **********/
</code>