Skip to main content
Each Redmine project has its own wiki — a set of collaboratively edited pages that support rich text formatting, file attachments, and a full revision history.

Create pages

Write and edit pages with CommonMark (Markdown) or Textile formatting.

Page history

View, compare, and restore previous versions of any page.

Link pages

Create an interconnected knowledge base with wiki links.

​
Enabling the wiki module

  1. Go to Project → Settings → Modules.
  2. Check Wiki.
  3. Click Save.
A Wiki link appears in the project sidebar. The first time you visit it, you can create the start page.

​
Creating and editing pages

1

Navigate to the wiki

Click Wiki in the project sidebar to open the start page.
2

Create a new page

Click New page and enter the page title. Titles are automatically capitalised and spaces are replaced with underscores internally. Only letters, digits, hyphens, and underscores are allowed — commas, dots, slashes, question marks, semicolons, and pipes are removed.
3

Write content

Enter your content in the text area. Redmine supports CommonMark (Markdown) and Textile depending on your instance configuration. CommonMark is the default.
4

Set the parent page (optional)

Enter a Parent page to nest this page under another in the hierarchy.
5

Add attachments (optional)

Attach files to the page using the Files section at the bottom of the edit form.
6

Save

Click Save. The page is created and a new version is recorded in the history.
The wiki start page is configurable. Administrators or users with the manage_wiki permission can change which page acts as the start page.

​
Text formatting

The default formatter since Redmine 5.0. Uses the CommonMark Markdown specification via the commonmarker gem.
# Heading 1
## Heading 2

**bold**, *italic*, ~~strikethrough~~

- Unordered list item
1. Ordered list item

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |

[Link text](http://example.com)

[[Another Wiki Page]]
[[Another Wiki Page|Link label]]

{{toc}} — inserts a table of contents

​
Linking between pages

Use double-bracket syntax to link to other wiki pages in the same project: 
[[Page Title]]
[[Page Title|Custom link text]]
To link to a page in a different project’s wiki, prefix with the project identifier: 
[[project-identifier:Page Title]]
[[project-identifier:Page Title|Custom link text]]
When a page is renamed, Redmine automatically creates a redirect from the old title to the new one, so existing links continue to work.

​
Table of contents

Insert {{toc}} anywhere on a page to generate a linked table of contents based on the headings on that page. The TOC is rendered at the location of the macro.

​
Page hierarchy

Wiki pages can be organised into a tree by setting a Parent page. The wiki index view groups pages by their parent and shows them indented. Moving a page to a different parent also moves its children.
Moving a page to a different project’s wiki is supported only if you have the rename_wiki_pages permission in both the source and destination projects.

​
Page history and diffs

Every save creates a new version of the page. To view the history:
  1. Open the wiki page.
  2. Click History in the top-right menu.
  3. The history list shows each version with its author, date, and comment.
To compare two versions:
  1. Select the two versions you want to compare using the checkboxes.
  2. Click Diff to see a side-by-side or inline diff of the changes.
To restore a previous version:
  1. Open the desired version from the history.
  2. Click Edit and save without changes, or copy the content and paste it into the current version.
A page named Sidebar (case-insensitive) is automatically rendered as the wiki’s sidebar navigation. Edit this page to add links to frequently visited wiki pages.
The Sidebar page is protected by default. Only users with the protect_wiki_pages permission can edit it.

​
Watching wiki pages

Click Watch on any wiki page to receive email notifications whenever the page is edited. You can also watch the entire wiki by clicking Watch on the wiki index page.

​
Permissions

ActionPermission required
View wiki pagesview_wiki_pages
Edit wiki pagesedit_wiki_pages
Delete wiki pagesdelete_wiki_pages
Rename wiki pagesrename_wiki_pages
Protect wiki pagesprotect_wiki_pages
Manage wikimanage_wiki

Build docs developers (and LLMs) love

Get started for freeTalk to us