Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
wiki:syntax [2026/07/27 11:32] – created - external edit 127.0.0.1wiki:syntax [2026/09/28 12:56] (current) – spelling cory
Line 1: Line 1:
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.+[[doku>DokuWiki]] supports some simple markup languages, which tries to make the datafiles to be as readable as possible. 
 + 
 +There are two supported formats: 
 + 
 +1. github flavoured [markdown](https://github.github.com/gfm/). 
 +2. dokuwiki syntax, which is described below on this page. 
 + 
 +You can mix both, of these, and dokuwiki will parse it as best as it can. For this wiki, we prefer markdown, but much of the content is still in dokuwiki syntax from before markdown was supported. 
 + 
 +This page contains all possible dokuwiki markup syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. 
 + 
 +In addition to the default syntax, we have a couple dokuwiki [plugins that add some styling](syntax#syntax_plugins) options.
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 483: Line 494:
 ~~INFO:syntaxplugins~~ ~~INFO:syntaxplugins~~
  
 +A couple useful plugin-added formatting options are described here:
 +
 +### Alerts
 +
 +Added by [mikio plugin](https://github.com/nomadjimbob/mikioplugin/wiki/), alerts come in `danger`, `warning`, `primary`, `secondary`, `success`, `info`, `light`, and `dark`.
 +
 +`<alert danger> something to be careful about </alert>`
 +<alert danger> something to be careful about </alert>
 +
 +See the [mikio plugin](https://github.com/nomadjimbob/mikioplugin/wiki/) docs for wayyy more formatting options.
 +
 +### Metadata
 +
 +[This plugin](https://www.dokuwiki.org/plugin:meta) was added to allow pages to set custom titles. Without it, page titles will be the first header found on the page. An example where we use it is https://vanhack.ca/wiki/start where the title would be `Vancouver Hack Space - Vancouver Hack Space`, following the pattern `wikititle - pagetitle`, but we override the page title in the document using the meta plugin to be "Wiki Home"
 +allows you to edit the page metadata in the page contents. Syntax is:
 +
 +```
 +~~META:
 +title = Wiki Home
 +~~
 +```
 +
 +### Redirect
 +
 +We have two redirect plugins installed, one stores a master list of redirects - this was used to help fix broken links when we merged the WordPress and Dokuwiki into a single site. If you have a permanent redirect where you want to delete a page, ask in #vhs-wiki about getting something added to this list.
 +
 +The other redirect uses page contents to redirect to another page: `~~REDIRECT>namespace:page~~`