Wiki formatting (Markdown)

Links

Redmine links

Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.

Wiki links:

You can also link to pages of an other project wiki:

Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.

Links to other resources:

Escaping:

External links

HTTP URLs and email addresses are automatically turned into clickable links:

http://www.redmine.org, someone@foo.bar

displays: http://www.redmine.org, someone@foo.bar

If you want to display a specific text instead of the URL, you can use the standard markdown syntax:

[Redmine web site](http://www.redmine.org)

displays: Redmine web site

Text formatting

For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See http://daringfireball.net/projects/markdown/syntax for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.

Font style

* **bold**
* *Italic*
* ***bold italic***
* ~~strike-through~~

Display:

Inline images

Headings

# Heading
## Subheading
### Subsubheading

Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.

Blockquotes

Start the paragraph with >

> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.

Display:

Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.

Table of content

{{toc}} => left aligned toc
{{>toc}} => right aligned toc

Horizontal Rule

---

Macros

Redmine has the following builtin macros:

hello_world

Sample macro.

macro_list

Displays a list of all available macros, including description if available.

child_pages

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

{{child_pages}} -- can be used from a wiki page only
{{child_pages(depth=2)}} -- display 2 levels nesting only
include

Include a wiki page. Example:

{{include(Foo)}}

or to include a page of a specific project wiki:

{{include(projectname:Foo)}}
collapse

Inserts of collapsed block of text. Example:

{{collapse(View details...)
This is a block of text that is collapsed by default.
It can be expanded by clicking a link.
}}
thumbnail

Displays a clickable thumbnail of an attached image. Examples:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}

Code highlighting

Default code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

You can highlight code in your wiki page using this syntax:

~~~ ruby
  Place your code here.
~~~

Example:

 1 # The Greeter class
 2 class Greeter
 3   def initialize(name)
 4     @name = name.capitalize
 5   end
 6
 7   def salute
 8     puts "Hello #{@name}!"
 9   end
10 end