User Tools

Site Tools


example

This is an old revision of the document!


DokuWiki Syntax Cheatsheet

Text Formatting

Syntax Rendered
**bold** bold
//italic// italic
__underlined__ underlined
''monospace'' monospace
**//bold italic//** bold italic
~~strikethrough~~ ~~strikethrough~~

Headings

====== H1 ======
===== H2 =====
==== H3 ====
=== H4 ===
== H5 ==

Lists

  * Unordered item
    * Nested item

  - Ordered item
    - Nested item

Rendered:

  • Unordered item
    • Nested item
  1. Ordered item
    1. Nested item
Syntax Rendered
[[start]] start
[[start|Home]] Home
[[https://freebsd.org|FreeBSD]] FreeBSD

Code

''inline code''

Rendered: inline code

<code bash>
service nginx reload

</code>

Rendered:

service nginx reload

Tables

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

Rendered:

Header 1 Header 2
Cell 1 Cell 2
Cell 3 Cell 4

Images

{{wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png|caption}}
{{wiki:dokuwiki-128.png?100}}

Namespaces

[[servers:sanctum]]
[[services:vaultwarden]]

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

References

<code> Some text needing referencing1)

Some more text2) <code/>

Images

some text to describe this

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

Comments

The text is hidden


You can also have multi-line comments:

/**
 * @todo: rewrite this section to reflect changes made recently
 *
 * this is a longer note
 */

But this single line example works too:

/********** added by Esther **********/
1)
This is the footnote/reference text.
2)
https://git.labunix.xyz accessed on: 2026-06-09
example.1781035178.txt.gz · Last modified: by lukasz