====== DokuWiki Syntax Quick Guide ====== Welcome! This page is designed to show you how DokuWiki syntax works. By editing this page, you can see how the code is written to generate what you are reading. ===== 1. Text Formatting ===== You can easily apply different styles to your text: * **Bold text** (surrounded by two asterisks). * //Italic text// (surrounded by two slashes). * __Underlined text__ (surrounded by two underscores). * ''Monospaced text'' (surrounded by two single quotes). * Subscript and Superscript (using tags). * Strikethrough text (using tags). ===== 2. Headlines ===== You can structure your content using up to 5 levels of headlines. The more equals signs (`=`) you use around the text, the higher the headline level. ==== Level 3 Headline ==== === Level 4 Headline === == Level 5 Headline == ===== 3. Lists ===== ==== Unordered Lists (Bullets) ==== To create a bulleted list, leave two spaces at the beginning of the line and use an asterisk: * Item 1 * Item 2 * Sub-item (four spaces before the asterisk) * Another sub-item ==== Ordered Lists (Numbers) ==== To create a numbered list, leave two spaces at the beginning of the line and use a hyphen: - First step - Second step - Sub-step (four spaces before the hyphen) ===== 4. Links ===== DokuWiki allows you to create links easily: * **Internal links (to another page in your wiki):** [[namespace:page_name|Text to display]] * **External links:** [[https://www.google.com|Go to Google]] * **Emails:** ===== 5. Images and Files ===== You can insert images using double curly brackets. If you add vertical bars (`|`), you can add a title or resize it: {{wiki:dokuwiki-128.png|DokuWiki Logo}} {{wiki:dokuwiki-128.png?50|Logo resized to 50 pixels}} ===== 6. Tables ===== Use the caret symbol (`^`) for headers and the vertical bar (`|`) for normal cells. ^ Header 1 ^ Header 2 ^ Header 3 ^ | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 | ===== 7. Code Blocks and Unformatted Text ===== If you need to show source code, use the '''' and '''' tags. For text you don't want DokuWiki to format, use the '''' and '''' tags. Here I can use **asterisks** and //slashes// without formatting being applied. ===== 8. Quotes ===== Use the greater-than sign (`>`) to create blockquotes. > This is an example quote. >> This is a nested quote inside the previous one. >>> And this is an even deeper quote. ===== 9. Horizontal Rules ===== To create a separator line, simply write four or more hyphens in a row: ----