Quickstart: Add and edit wiki pages

Azure DevOps Services | Azure DevOps Server 2019 | TFS 2018

When the Wiki Git repository is provisioned for your team project, you have a new page where you can add a title and content. There is a side-by-side edit and preview experience where you can edit the page and preview the content as you go.

In this quickstart, learn how to do the following tasks:

  • Open wiki
  • Add a wiki page
  • View revisions for a page
  • Edit and delete wiki pages
  • Reorder wiki pages
  • Make a page the wiki home page

While you author pages using Markdown format, you can also use the format pane for rich-text formatting and inserting images, attachments, and links.

Wiki home page

As you edit the page, save it by entering Ctrl+S. To save with a custom revision message, select the context menu icon next to Save. For additional shortcuts, see Keyboard shortcuts to manage Wiki pages.

Save page with a custom message

Note

To add or edit pages to a wiki that you've published from a Git repository, see Publish a Git repository to a wiki. This article addresses how to add and edit pages of a wiki that you've provisioned for a team project.

Prerequisites

  • You must have a provisioned wiki. If your wiki hasn't yet been created, do that now.
  • You must be a member of the team project as a contributor to add or update wiki pages.

Open the Wiki

Connect to your project using a supported web browser and choose Wiki.

Create wiki, provision a Git repo for your wiki or publish existing repo Markdown files

If you need to switch your team project, choose the  Azure DevOps logo to browse all team projects and teams.

Add a wiki page

To add another page, choose New page. Or, to add a subpage, open the context menu of an existing page and select Add subpage.

Specify a unique title of 235 characters or less. Page titles are case-sensitive. For other title restrictions, see Wiki Git repository files and file structure, File naming conventions.

Create wiki and first page

You can also use keyboard shortcuts to add a new page by pressing n or add a subpage by pressing c. For a complete list of keyboard shortcuts, see Keyboard shortcuts to manage Wiki pages.

Wiki page title naming restrictions

Each wiki page corresponds to a file within the wiki Git repo. Names you assign to a wiki page title must conform to the following restrictions.

Restriction type Restriction
File name The fully qualified page path shouldn't exceed 235 characters.
Uniqueness Page titles are case sensitive and must be unique within the wiki hierarchy.
Special characters
  1. Must not contain any Unicode control characters or surrogate characters
  2. Must not contain the following printable characters: / \ #
  3. Must not start or end with a period (.)
  4. Must not contain a blank space.
File size Must not exceed the maximum of 18 MB
Attachment file size Must not exceed the maximum of 19 MB

Special characters in Wiki page titles

You can specify page titles which contain one or more of these special characters : < > * ? | -. For example, you can name a Markdown file as "FAQ?" or "Set-up guide". The following characters are translated to their URI encoded strings:

Character Encoded string
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22
Restriction type Restriction
File name The fully qualified page path shouldn't exceed 235 characters.
Uniqueness Page titles are case sensitive and must be unique within the wiki hierarchy.
Special characters
  1. Must not contain any Unicode control characters or surrogate characters
  2. Must not contain the following printable characters: / : < \ * ? \ | - #
  3. Must not start or end with a period (.)
  4. Titles of pages added offline titles must not contain a blank space.
File size Must not exceed the maximum of 18 MB
Attachment file size Must not exceed the maximum of 19 MB

Edit and delete wiki pages

To edit an existing Wiki page, open the page and select Edit, or open the context menu and select Edit. You can also use keyboard shortcut e to quickly navigate to the edit of the current page.

For code wikis, you can edit wiki pages in Repos hub also by using the option Edit in Repos

Create wiki and first page

Note

If you have branch policies in your code wiki, use "Edit in Repos" to create a branch and continue editing.

To delete a page, open the context menu from the tree or the one inside the page and select Delete. Confirm the delete in the dialog box that opens.

Note

Deleting a page deletes the page along with all the metadata and all its sub pages (if any) in the hierarchy.

Reorder a wiki page

You can reorder pages within the wiki tree view to have pages appear in the order and hierarchy you want. You can drag-and-drop a page title in the tree view to perform the following operations:

  • Change the parent-child relationship of a page
  • Change the order of the page within the hierarchy

Note

Moving a page in the hierarchy may break links to it from other pages. You can always fix the links manually after you move. Reordering a page within a hierarchy has no impact on page links.

You can also use keyboard shortcuts to reorder pages. Select a page and press CTRL + UP ARROW or CTRL + DOWN ARROW to change page orders. To change the parent-child relationship of a page, open its context menu and select Move. The Move page dialog opens. Select a parent page under which you can move the current page.

Move wiki page in the hierarchy

For a complete list of keyboard shortcuts, see Keyboard shortcuts to manage Wiki pages.

Make a page the wiki home page

By default, the first page you add when you create a wiki is set as the wiki home page. You can change this if another page becomes more relevant. You have to just drag and drop the page to the top of the tree.

Next steps