Redmine Markdown

• Redmine Markdown
• Redmine Markdown Manager
• Redmine Markdown Image
• Redmine Markdown Html

Overview

Returns a cache key for the given text format, text, object and attribute or nil if no caching should be done.cachestore ⇒ Object. Redmine allows hyperlinking between resources (issues, changesets, wiki pages.) from anywhere wiki formatting is used. Link to an issue: #124 (displays #124, link is striked-through if the issue is closed). Redmineは見出しにアンカーを設定するので、'#Heading', '#Subheading'のように記述して見出しへのリンクが行えます。 引用 段落を で開始してください。. If you want to display a specific text instead of the URL, you can use the standard markdown syntax: Redmine web site(displays: Redmine web site.

Nearly all Markdown applications support the basic syntax outlined in John Gruber’s original design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.

Headings

To create a heading, add number signs (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (<h3>), use three number signs (e.g., ### My Header).

Markdown	HTML	Rendered Output
# Heading level 1	<h1>Heading level 1</h1>
## Heading level 2	<h2>Heading level 2</h2>	Heading level 2
### Heading level 3	<h3>Heading level 3</h3>	Heading level 3
#### Heading level 4	<h4>Heading level 4</h4>	Heading level 4
##### Heading level 5	<h5>Heading level 5</h5>	Heading level 5
###### Heading level 6	<h6>Heading level 6</h6>	Heading level 6

Alternate Syntax

Alternatively, on the line below the text, add any number of characters for heading level 1 or -- characters for heading level 2.

Markdown	HTML	Rendered Output
Heading level 1	<h1>Heading level 1</h1>
Heading level 2 ---------------	<h2>Heading level 2</h2>	Heading level 2

Heading Best Practices

Markdown applications don’t agree on how to handle a missing space between the number signs (#) and the heading name. For compatibility, always put a space between the number signs and the heading name.

✅ Do this	❌ Don't do this
# Here's a Heading	#Here's a Heading

Paragraphs

To create paragraphs, use a blank line to separate one or more lines of text.

Markdown	HTML	Rendered Output
I really like using Markdown. I think I'll use it to format all of my documents from now on.	<p>I really like using Markdown.</p> <p>I think I'll use it to format all of my documents from now on.</p>	I really like using Markdown. I think I'll use it to format all of my documents from now on.

Paragraph Best Practices

Unless the paragraph is in a list, don’t indent paragraphs with spaces or tabs.

✅ Do this	❌ Don't do this
Don't put tabs or spaces in front of your paragraphs. Keep lines left-aligned like this.	This can result in unexpected formatting problems. Don't add tabs or spaces in front of paragraphs.

Line Breaks

To create a line break (<br>), end a line with two or more spaces, and then type return.

Markdown	HTML	Rendered Output
This is the first line. And this is the second line.	<p>This is the first line.<br> And this is the second line.</p>	This is the first line. And this is the second line.

Line Break Best Practices

You can use two or more spaces (commonly referred to as “trailing whitespace”) for line breaks in nearly every Markdown application, but it’s controversial. It’s hard to see trailing whitespace in an editor, and many people accidentally or intentionally put two spaces after every sentence. For this reason, you may want to use something other than trailing whitespace for line breaks. Fortunately, there is another option supported by nearly every Markdown application: the <br> HTML tag.

For compatibility, use trailing white space or the <br> HTML tag at the end of the line.

There are two other options I don’t recommend using. CommonMark and a few other lightweight markup languages let you type a backslash () at the end of the line, but not all Markdown applications support this, so it isn’t a great option from a compatibility perspective. And at least a couple lightweight markup languages don’t require anything at the end of the line — just type return and they’ll create a line break.

✅ Do this	❌ Don't do this
First line with two spaces after. And the next line. First line with the HTML tag after.<br> And the next line.	First line with a backslash after. And the next line. First line with nothing after. And the next line.

Emphasis

You can add emphasis by making text bold or italic.

Bold

To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

Markdown	HTML	Rendered Output
I just love **bold text**.	I just love <strong>bold text</strong>.	I just love bold text.
I just love __bold text__.	I just love <strong>bold text</strong>.	I just love bold text.
Love**is**bold	Love<strong>is</strong>bold	Loveisbold

Bold Best Practices

Markdown applications don’t agree on how to handle underscores in the middle of a word. For compatibility, use asterisks to bold the middle of a word for emphasis.

✅ Do this	❌ Don't do this
Love**is**bold	Love__is__bold

Italic

To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.

Markdown	HTML	Rendered Output
Italicized text is the *cat's meow*.	Italicized text is the <em>cat's meow</em>.	Italicized text is the cat’s meow.
Italicized text is the _cat's meow_.	Italicized text is the <em>cat's meow</em>.	Italicized text is the cat’s meow.
A*cat*meow	A<em>cat</em>meow	Acatmeow

Italic Best Practices

Markdown applications don’t agree on how to handle underscores in the middle of a word. For compatibility, use asterisks to italicize the middle of a word for emphasis.

✅ Do this	❌ Don't do this
A*cat*meow	A_cat_meow

Bold and Italic

To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.

Markdown	HTML	Rendered Output
This text is ***really important***.	This text is <strong><em>really important</em></strong>.	This text is really important.
This text is ___really important___.	This text is <strong><em>really important</em></strong>.	This text is really important.
This text is __*really important*__.	This text is <strong><em>really important</em></strong>.	This text is really important.
This text is **_really important_**.	This text is <strong><em>really important</em></strong>.	This text is really important.
This is really***very***important text.	This is really<strong><em>very</em></strong>important text.	This is reallyveryimportant text.

Bold and Italic Best Practices

Markdown applications don’t agree on how to handle underscores in the middle of a word. For compatibility, use asterisks to bold and italicize the middle of a word for emphasis.

✅ Do this	❌ Don't do this
This is really***very***important text.	This is really___very___important text.

Blockquotes

To create a blockquote, add a > in front of a paragraph.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

Blockquotes with Multiple Paragraphs

Blockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Nested Blockquotes

Blockquotes can be nested. Add a >> in front of the paragraph you want to nest.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Blockquotes with Other Elements

Blockquotes can contain other Markdown formatted elements. Not all elements can be used — you’ll need to experiment to see which ones work.

The rendered output looks like this:

The quarterly results look great!

• Revenue was off the chart.
• Profits were higher than ever.

Everything is going according to plan.

Lists

You can organize items into ordered and unordered lists.

Ordered Lists

To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one.

Markdown	HTML	Rendered Output
1. First item 2. Second item 3. Third item 4. Fourth item	<ol> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ol>	First item Second item Third item Fourth item
1. First item 1. Second item 1. Third item 1. Fourth item	<ol> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ol>	First item Second item Third item Fourth item
1. First item 8. Second item 3. Third item 5. Fourth item	<ol> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ol>	First item Second item Third item Fourth item
1. First item 2. Second item 3. Third item 1. Indented item 2. Indented item 4. Fourth item	<ol> <li>First item</li> <li>Second item</li> <li>Third item <ol> <li>Indented item</li> <li>Indented item</li> </ol> </li> <li>Fourth item</li> </ol>	First item Second item Third item Indented item Indented item Fourth item

Ordered List Best Practices

CommonMark and a few other lightweight markup languages let you use a parenthesis ()) as a delimiter (e.g., 1) First item), but not all Markdown applications support this, so it isn’t a great option from a compatibility perspective. For compatibility, use periods only.

✅ Do this	❌ Don't do this
1. First item 2. Second item	1) First item 2) Second item

Unordered Lists

To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list.

Markdown	HTML	Rendered Output
- First item - Second item - Third item - Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First item Second item Third item Fourth item
* First item * Second item * Third item * Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First item Second item Third item Fourth item
+ First item + Second item + Third item + Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First item Second item Third item Fourth item
- First item - Second item - Third item - Indented item - Indented item - Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item <ul> <li>Indented item</li> <li>Indented item</li> </ul> </li> <li>Fourth item</li> </ul>	First item Second item Third item Indented item Indented item Fourth item

Starting Unordered List Items With Numbers

If you need to start an unordered list item with a number followed by a period, you can use a backslash () to escape the period.

Markdown	HTML	Rendered Output
- 1968. A great year! - I think 1969 was second best.	<ul> <li>1968. A great year!</li> <li>I think 1969 was second best.</li> </ul>	1968. A great year! I think 1969 was second best.

Unordered List Best Practices

Markdown applications don’t agree on how to handle different delimiters in the same list. For compatibility, don’t mix and match delimiters in the same list — pick one and stick with it.

✅ Do this	❌ Don't do this
- First item - Second item - Third item - Fourth item	+ First item * Second item - Third item + Fourth item

Adding Elements in Lists

To add another element in a list while preserving the continuity of the list, indent the element four spaces or one tab, as shown in the following examples.

Paragraphs

The rendered output looks like this:

• This is the first list item.

• Here’s the second list item.

  I need to add another paragraph below the second list item.

• And here’s the third list item.

Blockquotes

The rendered output looks like this:

• This is the first list item.

• Here’s the second list item.

  A blockquote would look great below the second list item.

• And here’s the third list item.

Code Blocks

Code blocks are normally indented four spaces or one tab. When they’re in a list, indent them eight spaces or two tabs.

The rendered output looks like this:

1. Open the file.

2. Find the following code block on line 21:

3. Update the title to match the name of your website.

Images

The rendered output looks like this:

1. Open the file containing the Linux mascot.

2. Marvel at its beauty.

3. Close the file.

Lists

You can nest an unordered list in an ordered list, or vice versa.

The rendered output looks like this:

1. First item
2. Second item
3. Third item
   • Indented item
   • Indented item
4. Fourth item

Code

To denote a word or phrase as code, enclose it in backticks (`).

Markdown	HTML	Rendered Output
At the command prompt, type `nano`.	At the command prompt, type <code>nano</code>.	At the command prompt, type nano.

Escaping Backticks

If the word or phrase you want to denote as code includes one or more backticks, you can escape it by enclosing the word or phrase in double backticks (``).

Markdown	HTML	Rendered Output
``Use `code` in your Markdown file.``	<code>Use `code` in your Markdown file.</code>	Use `code` in your Markdown file.

Code Blocks

To create code blocks, indent every line of the block by at least four spaces or one tab.

The rendered output looks like this:

Horizontal Rules

To create a horizontal rule, use three or more asterisks (***), dashes (---), or underscores (___) on a line by themselves.

The rendered output of all three looks identical:

Horizontal Rule Best Practices

For compatibility, put blank lines before and after horizontal rules.

✅ Do this	❌ Don't do this
Try to put a blank line before... --- ...and after a horizontal rule.	Without blank lines, this would be a heading. --- Don't do this!

Links

To create a link, enclose the link text in brackets (e.g., [Duck Duck Go]) and then follow it immediately with the URL in parentheses (e.g., (https://duckduckgo.com)).

The rendered output looks like this:

My favorite search engine is Duck Duck Go.

Adding Titles

You can optionally add a title for a link. This will appear as a tooltip when the user hovers over the link. To add a title, enclose it in parentheses after the URL.

The rendered output looks like this:

My favorite search engine is Duck Duck Go.

URLs and Email Addresses

To quickly turn a URL or email address into a link, enclose it in angle brackets.

The rendered output looks like this:

https://www.markdownguide.org
fake@example.com

Formatting Links

To emphasize links, add asterisks before and after the brackets and parentheses. To denote links as code, add backticks in the brackets.

The rendered output looks like this:

I love supporting the EFF.
This is the Markdown Guide.
See the section on code.

Reference-style Links

Reference-style links are a special kind of link that make URLs easier to display and read in Markdown. Reference-style links are constructed in two parts: the part you keep inline with your text and the part you store somewhere else in the file to keep the text easy to read.

Formatting the First Part of the Link

The first part of a reference-style link is formatted with two sets of brackets. The first set of brackets surrounds the text that should appear linked. The second set of brackets displays a label used to point to the link you’re storing elsewhere in your document.

Although not required, you can include a space between the first and second set of brackets. The label in the second set of brackets is not case sensitive and can include letters, numbers, spaces, or punctuation.

This means the following example formats are roughly equivalent for the first part of the link:

• [hobbit-hole][1]
• [hobbit-hole] [1]

Formatting the Second Part of the Link

The second part of a reference-style link is formatted with the following attributes:

1. The label, in brackets, followed immediately by a colon and at least one space (e.g., [label]: ).
2. The URL for the link, which you can optionally enclose in angle brackets.
3. The optional title for the link, which you can enclose in double quotes, single quotes, or parentheses.

This means the following example formats are all roughly equivalent for the second part of the link:

• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

You can place this second part of the link anywhere in your Markdown document. Some people place them immediately after the paragraph in which they appear while other people place them at the end of the document (like endnotes or footnotes).

An Example Putting the Parts Together

Say you add a URL as a standard URL link to a paragraph and it looks like this in Markdown:

Though it may point to interesting additional information, the URL as displayed really doesn’t add much to the existing raw text other than making it harder to read. To fix that, you could format the URL like this instead:

In both instances above, the rendered output would be identical:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a hobbit-hole, and that means comfort.

and the HTML for the link would be:

Link Best Practices

Markdown applications don’t agree on how to handle spaces in the middle of a URL. For compatibility, try to URL encode any spaces with %20.

✅ Do this	❌ Don't do this
[link](https://www.example.com/my%20great%20page)	[link](https://www.example.com/my great page)

Images

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title after the URL in the parentheses.

The rendered output looks like this:

Linking Images

To add a link to an image, enclose the Markdown for the image in brackets, and then add the link in parentheses.

The rendered output looks like this:

Escaping Characters

To display a literal character that would otherwise be used to format text in a Markdown document, add a backslash () in front of the character.

The rendered output looks like this:

* Without the backslash, this would be a bullet in an unordered list.

Characters You Can Escape

You can use a backslash to escape the following characters.

Character	Name
	backslash
`	backtick (see also escaping backticks in code)
*	asterisk
_	underscore
{ }	curly braces
[ ]	brackets
< >	angle brackets
( )	parentheses
#	pound sign
+	plus sign
-	minus sign (hyphen)
.	dot
!	exclamation mark
|	pipe (see also escaping pipe in tables)

HTML

Many Markdown applications allow you to use HTML tags in Markdown-formatted text. This is helpful if you prefer certain HTML tags to Markdown syntax. For example, some people find it easier to use HTML tags for images. Using HTML is also helpful when you need to change the attributes of an element, like specifying the color of text or changing the width of an image.

To use HTML, place the tags in the text of your Markdown-formatted file.

The rendered output looks like this:

This word is bold. This word is italic.

HTML Best Practices

For security reasons, not all Markdown applications support HTML in Markdown documents. When in doubt, check your Markdown application’s documentation. Some applications support only a subset of HTML tags.

Use blank lines to separate block-level HTML elements like <div>, <table>, <pre>, and <p> from the surrounding content. Try not to indent the tags with tabs or spaces — that can interfere with the formatting.

You can’t use Markdown syntax inside block-level HTML tags. For example, <p>italic and **bold**</p> won’t work.

Take your Markdown skills to the next level.

Learn Markdown in 60 pages. Designed for both novices and experts, The Markdown Guide book is a comprehensive reference that has everything you need to get started and master Markdown syntax.

Get the Book

Want to learn more Markdown?

Don't stop now! 😎 Star the GitHub repository and then enter your email address below to receive new Markdown tutorials via email. No spam!

Below is Markdown formatting. For Textile formatting see Textile formatting.
Currently HTML tags are not allowed by default. See #15520 and #20497 for details. For other limitations of the current Markdown formatting see #16373 and #21443.

• Markdown formatting
  • Links
  • Text formatting

Links¶

Redmine links¶

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

Wiki links:

• [[Guide]] displays a link to the page named 'Guide': Guide
• [[Guide#further-reading]] takes you to the anchor 'further-reading'. Headings get automatically assigned anchors so that you can refer to them: Guide
• [[Guide|User manual]] displays a link to the same page but with different text: User manual
• [[Guide#User-guide|User guide]] displays a link to the header on the same page with different text: User guide

You can also link to pages of another project's wiki (using the project identifier):

• [[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki
• [[sandbox:]] displays a link to the Sandbox wiki main page

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

Links to other resources:

• Issues:
  • #124 (link to an issue: displays #124, link is striked-through if the issue is closed)
  • #124-6, or #124#note-6 (link to an issue note: displays #124-6, or #124#note-6)

• Documents:
  • document#17 (link to document with id 17)
  • document:Greetings (link to the document with title 'Greetings')
  • document:'Some document' (double quotes can be used when document title contains spaces)
  • sandbox:document:'Some document' (link to a document with title 'Some document' in project identifier 'sandbox')

• Versions:
  • version#3 (link to version with id 3)
  • version:1.0.0 (link to version named '1.0.0')
  • version:'1.0 beta 2' (double quotes can be used when version name contains spaces)
  • sandbox:version:1.0.0 (link to version '1.0.0' in the project identifier 'sandbox')

• Attachments:
  • attachment:file.zip (link to the attachment of the current object named file.zip)
  • attachment:'file name.zip' (double quotes can be used when the filename contains non word characters)
  • For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)

• Changesets:
  • r758 (link to a changeset, displays r758)
  • commit:c6f4d0fd (link to a changeset with a non-numeric hash)
  • svn1|r758 (link to a changeset of a specific repository, for projects with multiple repositories)
  • commit:hg|c6f4d0fd (link to a changeset with a non-numeric hash of a specific repository)
  • sandbox:r758 (link to a changeset of another project)
  • sandbox:commit:c6f4d0fd (link to a changeset with a non-numeric hash of another project identifier)

• Repository files:
  • source:some/file (link to the file located at /some/file in the project's repository)
  • source:'some file' (link to the file with non word characters in the path)
  • source:some/file@52 (link to the file's revision 52)
  • source:some/file@master (link to the file in branch master)
  • source:some/file#L120 (link to line 120 of the file)
  • source:some/file@52#L120 (link to line 120 of the file's revision 52)
  • source:repo_identifier|some/file (link to a file of a specific repository, for projects with multiple repositories)
  • sandbox:source:some/file (link to the file in the project identifier 'sandbox')
  • sandbox:source:repo_identifier|some/file (link to the file, with non word characters in the path, of a specific repository in the project identifier 'sandbox')
  • export:some/file (force the download of the file)

• Forums:
  • forum#2 (link to forum with id 2)
  • forum:Discussion (link to forum with name 'Discussion')
  • forum:'Help and more' (double quotes can be used when forum name contains spaces)

• Forum messages:
  • message#1218 (link to message with id 1218)

• News items
  • news#1 (link to news item with id 1)
  • news:Greetings (link to news item with name 'Greetings')
  • news:'eCookbook first release !' (double quotes can be used when news item name contains spaces)

• Projects:
  • project#3 (link to project with id 3)
  • project:someproject (link to project with name 'someproject')
  • project:'Multiple words project' (double quotes can be used when project name contains spaces)

• Users:
  • user#2 (link to user with id 2)
  • user:jsmith (Link to user with login 'jsmith')
  • @jsmith (Link to user with login 'jsmith')

Escaping:

• You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !

External links¶

URLs (http, https, ftp and ftps) are automatically turned into clickable links:

• http://www.redmine.org -- External link to the redmine website: http://www.redmine.org

URLs can also use different text than the link itself:

• [Redmine web site](http://www.redmine.org) -- External link with different text: Redmine web site
• [](http://www.redmine.org) -- External image with a title that links to an URL:

Email addresses¶

Email addresses are automatically turned into clickable links:

• someone@foo.bar -- Link to an email address: someone@foo.bar
• [Email someone](mailto:someone@foo.bar) -- Email link with different text: Email someone

More complex email instructions can be added to an email link. A default subject, default body and CC information can be defined. Note that spaces in any of these fields need to be replaced with the code %20.

• [Email webmaster and admin](mailto:webmaster@foo.bar?cc=admin@foo.bar) -- Email to webmaster, CC admin: Email webmaster and admin
• [Email someone for help](mailto:someone@foo.bar?subject=Website%20Help) -- Email link with the subject 'Website Help': Email someone for help
• [Email someone for help](mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20) -- Email link with the subject 'Website Help' and a default body: Email someone for help

Text formatting¶

For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax. See http://daringfireball.net/projects/markdown/syntax, http://agea.github.io/tutorial.md/, http://stackoverflow.com/editing-help for information on using any of these features. A few samples are included below, but the engine is capable of much more of that. For conversions see Pandoc. The Redcarpet formatter is used.

Acronym¶

Not supported by Markdown

Font style¶

displays:

• boldbold
• italicitalic
• bold italicbold italic
• strike-through
• Plain ^superscript
• Plain _subscript
• inline monospace
• normal bolditalic normal;E=mc²
• normalbolditalicnormal;E=mc²
• Escaping: **bold** _italic_ `inlinemono`

Note: HTML tags need to be allowed to use the HTML tags (<strong>, <em>, <ins>, <del>, <sup>, <sub>). See #15520-16 and #15520-17 for details.

Color¶

displays:

• redgreenyellowblue'ish
• redgreenyellowblue'ish
• Lightgreen BackgroundYellow Background
• Lightgreen BackgroundYellow Background

Note: HTML tags need to be allowed to use the HTML tag (<span>). See #15520-16 and #15520-17 for details.
More explicitly, you need to patch redmine, as explained in this post

Inline images¶

•  displays an image located at image_url (textile syntax)
•  displays an image with an alt/title attribute
• [](URL) displays an image located at image_url with link URL added

If you have an image attached to your wiki page, it can be displayed inline using its filename: .

As of this writing, Markdown has no syntax for specifying the dimensions of an image; if this is important to you, you can use regular HTML <img> tags.

• <img src='URL'/>
• <img src='attached_image.png'/>

Note: HTML tags need to be allowed to use the HTML tag (<img>). See #15520-16 and #15520-17 for details.

Headings¶

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

Paragraphs¶

Markdown does not support alignment of a paragraph. Use <div> tags if you need it.

displays;

left aligned

left ident 1em

left ident 2em
as well as for following lines

right aligned

right ident 3em

This is centered paragraph.

Note: HTML tags need to be allowed to use the HTML tags (<div>). See #15520-16 and #15520-17 for details.

Horizontal rule¶

----

displays:

Preformatted Text¶

displays:

Blockquotes¶

Redmine Markdown

You can use > at the beginning of each line and stack them for nested quotes:

displays:

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.

Great!

Unordered lists¶

Unordered lists use asterisks (*), pluses (+), and hyphens (-) as list markers

displays:

• Item 1
• Item 2
  • Item 21
  • Item 22
• Item 3

Ordered lists¶

Ordered lists use numbers followed by periods.

displays:

1. Item 1
2. Item 2
3. Item 3
   1. Item 3.1
   2. Item 3.2

Note that the actual numbers you use to mark the list have no effect on the output.

Tables¶

displays (all multiple spaces are replaced by 1 space):

UserID (align right)	Name (align left)	Group (align center)
2	John Smith
3	Dave Lopper	A Team
4	Robert Hill	B Team

Table of content¶

Please keep in mind, that the toc-tag needs an empty line above and underneath it and no other text before and after it.

Example:

Footnotes¶

A footnote works very much like a reference-style link: it consists of a marker next to the text, e.g. and a footnote definition on its own line anywhere within the document, e.g.

Macros¶

Redmine Markdown Manager

Redmine includes a macros system that lets you add custom functions to insert dynamic content in formatted text. You can learn about writing your own macros in RedmineMacros. Redmine also includes a few 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:

include

Include a wiki page. Example:

or to include a page of a specific project wiki:

collapse

Inserts of collapsed block of text. Example:

thumbnail

Displays a clickable thumbnail of an attached image. Examples:

sample_macro

Sample macro

Code highlighting¶

Default code highlightment relies on Rouge, a syntax highlighting library written in pure Ruby. It 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, where the names inside parentheses are aliases. Please refer to RedmineCodeHighlightingLanguages for the full list of supported languages.

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

Example:

Redmine Markdown Image

Translation¶

Redmine Markdown Html

Note that the following translations may not be up to date. Please refer to the original english documentation if needed.