<%= stylesheet_link_tag "wiki_syntax_detailed.css" %>

Wiki formatting (CommonMark Markdown (GitHub Flavored))

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

URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:

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

displays: https://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](https://www.redmine.org)

displays: Redmine web site

Text formatting

For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax according to CommonMark including some extensions commonly referred to as GitHub flavored Markdown. See the GitHub Flavored Markdown Spec 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)}}
issue

Inserts a link to an issue with flexible text. Examples:

{{issue(123)}}                              -- Issue #123: Enhance macro capabilities
{{issue(123, project=true)}}                -- Andromeda - Issue #123:Enhance macro capabilities
{{issue(123, tracker=false)}}               -- #123: Enhance macro capabilities
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123
recent_pages

Displays a list of recently updated wiki pages. With no argument, it displays pages that have been updated within the last 7 days. Examples:

{{recent_pages}}            -- displays pages updated within the last 7 days
{{recent_pages(days=3)}}    -- displays pages updated within the last 3 days
{{recent_pages(limit=5)}}   -- limits the maximum number of pages to display to 5
{{recent_pages(time=true)}} -- displays pages updated within the last 7 days with updated time

Code highlighting

Default code highlighting relies on Rouge, a pure Ruby code highlighter. Rouge supports many commonly used languages such as c, cpp (c++), csharp (c#, cs), css, diff (patch, udiff), go (golang), groovy, html, java, javascript (js), kotlin, objective_c (objc), perl (pl), php, python (py), r, ruby (rb), sass, scala, shell (bash, zsh, ksh, sh), sql, swift, xml and yaml (yml) languages - the names inside parentheses are aliases. Please refer to the list of languages supported by Redmine code highlighter.

You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):

```ruby
  Place your code here.
```

Example:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!"
  end
end

Raw HTML

You may use raw HTML for more complex formatting tasks, i.e. complex tables with cells spanning multiple rows or columns:


    <table width="50%">
      <tr><td rowspan="2">Two rows</td><td>foo</td></tr>
      <tr><td>bar</td></tr>
      <tr><td align="center" colspan="2">bar</td></tr>
    </table>

yields

Two rowsfoo
bar
bar

The style attribute can be used in raw HTML to apply custom formatting. The following CSS properties are allowed:


  color background-color
  width min-width max-width
  height min-height max-height
  padding padding-left padding-right padding-top padding-bottom
  margin margin-left margin-right margin-top margin-bottom
  border border-left border-right border-top border-bottom border-radius border-style border-collapse border-spacing
  font font-style font-variant font-weight font-stretch font-size line-height font-family
  text-align
  float

Alerts

NOTE
> [!NOTE]
> Wiki page edits are preserved as history, allowing you to restore previous versions if needed.

Note

Wiki page edits are preserved as history, allowing you to restore previous versions if needed.

TIP
> [!TIP]
> To quickly review the update history of an issue, use the "History" tab for convenient access.

Tip

To quickly review the update history of an issue, use the "History" tab for convenient access.

WARNING
> [!WARNING]
> Deleting an issue is a permanent action. Be certain it is truly necessary before proceeding.

Warning

Deleting an issue is a permanent action. Be certain it is truly necessary before proceeding.

IMPORTANT
> [!IMPORTANT]
> Changing role permissions can affect user access across all projects, so be mindful of potential impacts.

Important

Changing role permissions can affect user access across all projects, so be mindful of potential impacts.

CAUTION
> [!CAUTION]
> When installing plugins, make sure to verify compatibility. Version differences can cause unexpected behavior.

Caution

When installing plugins, make sure to verify compatibility. Version differences can cause unexpected behavior.