Skip to content

Latest commit

 

History

History
288 lines (193 loc) · 11.4 KB

add-edit-wiki.md

File metadata and controls

288 lines (193 loc) · 11.4 KB
Raw
title titleSuffix description ms.subservice ms.custom ms.assetid ms.author author ms.reviewer ms.topic monikerRange ms.date
Add, edit, reorder, and manage wiki pages
Azure DevOps
Learn how to add, edit, reorder, and manage pages for your built-in project wiki in Azure DevOps.
azure-devops-wiki
wiki, devx-track-azurecli, devdivchpfy22
BD03B9EE-D4DC-4EDC-B0BF-5C11B34E14C9
chcomley
chcomley
gopinach
quickstart
<= azure-devops
04/12/2024

Add and edit wiki pages

[!INCLUDE version-lt-eq-azure-devops]

You can add a title and content to a page, after the wiki Git repository is provisioned for your team project. There's a side-by-side edit and preview experience where you can edit the page and preview the content as you go.

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

[!div class="mx-imgBorder"]
Wiki home page

As you edit the page, save it by entering Ctrl+S. To save with a custom revision message, select :::image type="icon" source="../../media/icons/context-menu.png" border="false":::next to Save. For more shortcuts, see Keyboard shortcuts to manage wiki pages.

[!div class="mx-imgBorder"]
Save page with a custom message

::: moniker range="azure-devops"

Wiki command-line tools

Commands Description
az devops wiki show Open a wiki
az devops wiki page show Get the content of a page or open a page
az devops wiki page create Add a new page
az devops wiki page update Edit a page
az devops wiki page delete Delete a page

::: moniker-end

::: moniker range=">= azure-devops-2019"

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.

::: moniker-end

Prerequisites

  • You must have a provisioned wiki.
  • You must be a member of the team project as a contributor to add or update wiki pages.
  • You must have Basic access level to edit the project wiki.

[!INCLUDE temp]

Add a wiki page

Browser

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.

[!div class="mx-imgBorder"]
Screenshot of first wiki 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.

Azure DevOps CLI

::: moniker range="azure-devops"

To add a wiki page, enter the az devops wiki page create command.

[!div class="tabbedCodeSnippets"]

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

Parameters

  • --path: Required. Path of the wiki page.
  • --wiki: Required. Name or ID of the wiki.
  • --comment: Optional. Comment in the commit message of the file add operation. Default value: Added a new page using Azure DevOps CLI.
  • --content: Optional. Content of the wiki page. Ignored if --file-path is specified.
  • --encoding: Optional. Encoding of the file. Used with --file-path parameter. accepted values: ascii, utf-16be, utf-16le, utf-8
  • --file-path: Optional. Path of the file input if the content is specified in the file.
  • --project -p: Required if not configured as default or picked up via git config. Name or ID of the project. You can configure the default project using the az devops configure -d project=NAME_OR_ID.

::: moniker-end [!INCLUDE temp]
::: moniker range="azure-devops"

Examples

Create a new page with the path 'my page' in a wiki named 'myprojectwiki' with inline content.

[!div class="tabbedCodeSnippets"]

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

Update content of the page with path 'my page' in a wiki with content from a file.

[!div class="tabbedCodeSnippets"]

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8

::: moniker-end

[!INCLUDE note-cli-not-supported]

Wiki page title naming restrictions

[!INCLUDE temp]

Edit and delete wiki pages

Browser

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 go to the edit of the current page quickly.

::: moniker range="> azure-devops-2020"

For code wikis, you can edit a page in the side-by-side editor, using the markdown toolbar to create your content. This experience is identical to the process in a project wiki. You can also edit wiki pages in the Repos hub also by using the option, Edit in Repos.

[!div class="mx-imgBorder"]
Screenshot of Edit wiki page.

If your code wiki has branch policies, select Edit in Repos to create a branch and continue editing. The Edit in Repos option is specifically available for code wikis.

::: moniker-end

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 that opens.

Note

When you delete a page, you also delete all the metadata and all its subpages (if any) in the hierarchy.

Azure DevOps CLI

::: moniker range="azure-devops"

Edit wiki page

To edit a wiki page, enter the az devops wiki page update command.

[!div class="tabbedCodeSnippets"]

az devops wiki page update --path
                           --version
                           --wiki
                           [--comment]
                           [--content]
                           [--file-path]
                           [--project]
                           [--subscription]

Parameters

  • --path: Required. Path of the wiki page.
  • --version -v: Required. Version (ETag) of the file to edit.
  • --wiki: Required. Name of ID of the wiki.
  • --comment: Optional. Comment in the commit message of delete operation.
  • --file-path: Optional. Path of the file input if the content is specified in the file.
  • --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.

::: moniker-end [!INCLUDE temp]
::: moniker range="azure-devops"

Examples

Update content of the page with path 'my page' in a wiki named 'myprojectwiki' with inline content.

[!div class="tabbedCodeSnippets"]

az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World" --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Update content of page with path 'my page' in a wiki with content from a file.

[!div class="tabbedCodeSnippets"]

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Delete wiki page

To delete a wiki page, enter the az devops wiki page delete command.

[!div class="tabbedCodeSnippets"]

az devops wiki page delete --path
                           --wiki
                           [--comment]
                           [--project]
                           [--subscription]
                           [--yes]

Parameters

  • --path: Required. Path of the wiki page.
  • --wiki: Required. Name or ID of the wiki.
  • --comment: Optional. Comment in the commit message of the delete operation.
  • --project -p: Optional. 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 via git config.
  • --subscription: Optional. Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
  • --yes -y: Optional. Don't prompt for confirmation.

[!INCLUDE note-cli-not-supported]

Example

Delete a wiki page with the path 'my wiki' in a wiki named 'myprojectwiki.'

[!div class="tabbedCodeSnippets"]

az devops wiki page delete --path 'my wiki' --wiki 'myprojectwiki'

::: moniker-end

[!INCLUDE note-cli-not-supported]

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 do 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.

[!div class="mx-imgBorder"]
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 your wiki homepage if another page becomes more relevant by dragging and dropping the page to the top of the tree.

Next steps

[!div class="nextstepaction"] View wiki page history and revert

Related articles