Create a wiki for your project

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

In this article, learn how to open a wiki and create a Git repo for your wiki. Every team project has a wiki. Use the wiki to share information with your team to understand and contribute to your project.

Each team project wiki is powered by a Git repository in the back-end. When you create a team project, a wiki Git repo isn't created by default. Create a Git repository to store your wiki Markdown files, or publish existing Markdown files from a Git repository to a wiki.

Prerequisites

• You must have a team project. If you don't have a team project yet, create one in Azure DevOps.
• You must have at least Basic access to create and modify a wiki.
• You must have the permission Create Repository to publish code as wiki. By default, this permission is set for members of the Project Administrators group.
• Anyone who is a member of the Contributors security group can add or edit wiki pages. Any user with access to the team project, including stakeholders, can view the wiki.

Open the Wiki

You can open and view a wiki page for your project.

Browser

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

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

Azure DevOps CLI

You can view and open a wiki page defined for a project using the az devops wiki show command. To get started, see Get started with Azure DevOps CLI.

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

Parameters

• --wiki: Required. Name or ID of the wiki.
• --open: Optional. Open the wiki page in your web browser.
• --project -p: Optional. Name or ID of the project.
• --subscription: Optional. Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Example

Open a wiki named 'myprojectwiki'.

az devops wiki show --wiki myprojectwiki --open

View a wiki page

To get the content of a page via the Azure DevOps CLI, enter the az devops wiki show command.

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

Parameters

• --path: Required. Path of the wiki page.
• --wiki: Required. Name or ID of the wiki.
• --include-content: Optional. Include content of the page.
• --open: Optional. Open the wiki page in your web browser.
• --project -p: Optional. Name or ID of the project.
• --version -v: Optional. Version (ETag) of the wiki page.

Example

Get wiki page content with path 'my wiki' in a wiki named 'myprojectwiki'.

az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"

Create a wiki Git repository

Browser

Create a new Git repository that stores all your wiki pages and related artifacts. From the wiki landing page, select Create Project wiki. Even if you use TFVC for source control, you can create a wiki with a Git repository.

If you don't have access to create a wiki Git repository or if you don't have access to any of the existing wikis, the following message appears.

Your administrator can create the wiki Git repository or you can request that they elevate your permissions. Stakeholders can't create a wiki, as they have no permissions to work in Repos or Code.

The wiki Git repo is referred as TeamProjectName.wiki. For example, if your team project is foobar then the wiki repo is labeled foobar.wiki.

Note

If you want to create more wikis, then you must publish code as a wiki. You can set up multiple wiki repos within a single project.

How can I go to the Git repository?

The TeamProjectName.wiki doesn't appear in the drop-down menu of repositories from Repos or Code. It also isn't in the list provided from the Project Settings > Repositories or Project Settings > Version Control pages.
However, you can get to it from the following URL:

https://dev.azure.com/<Org_Name>/<Team_Project_Name>/_git/<Wiki_Name>

Select Clone Wiki from the ellipsis near the wiki picker to access the wiki URL.

The URL of the wiki Git repository is exposed. Copy and paste it into your web browser to access the underlying Git repo.

Azure DevOps CLI

You can create a wiki with the az devops wiki create command. To get started, see Get started with Azure DevOps CLI.

Note

To create more than one wiki, you must publish code as a wiki. You can set up multiple wiki repos within a single project.

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Parameters

• mapped-path: (Required for the codewiki type). Mapped path of the new wiki. For example, you can specify / to publish from the root of the repository.
• name: (Required for the codewiki type). Name of the new wiki. If you don't specify a name for type projectwiki, then the new wiki gets named TeamProjectName.wiki.
• org: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up using git config. Example: --org https://dev.azure.com/MyOrganizationName/.
• project: Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up using git config.
• repository: (Required for the codewiki type). Name or ID of the repository to publish the wiki from.
• type: Type of wiki to create. The accepted values are projectwiki (default) and codewiki.
• version: (Required for the codewiki type). Repository branch name to publish the code wiki from.

Example

The following command creates a wiki named "Fabrikam Fiber" and shows the output in table format.

az devops wiki create --name "Fabrikam Fiber" --output table

ID                                    Name                 Type
------------------------------------  -------------------  -----------
7edcc35b-89be-465e-855e-377ba8660af7  Fabrikam Fiber.wiki  projectWiki

Next steps

Add and edit wiki pages