Events
Mar 17, 11 PM - Mar 21, 11 PM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register nowThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
You can update your wiki pages offline the same way you develop code in a Git repo.
You can use any client you want or git command-line tools to update your wiki offline. For details on working with Git repositories and supported tools, see Git Repositories.
The basic steps to update wiki content offline are as follows:
Category | Requirements |
---|---|
Project access | Member of the project where the wiki's located. If you don't have access, request it from your project administrator. |
Permissions | - Member of the Contributors group. - To publish code as wiki: Create Repository permission. By default, this permission is set for members of the Project Administrators group. |
Access levels | At least Basic access. |
Tasks | - Understand the underlying structure of your wiki Git repo - Understand the differences between provisioned wiki and publish code as wiki |
Your wiki repository stores pages, images, attachments, and the sequence of pages and subpages. Clone your wiki to begin.
Sign in to your project (https://dev.azure.com/{Your_Organization/Your_Project}
) and then select your wiki.
Open the More actions context menu and select Clone wiki.
From the Clone repo dialog, select
Copy clone URL to clipboard.
Enter it in your browser to view the files defined under the wikiMaster branch.
Important
The "Generate Git Credentials" button will be removed in January 2025, to reduce creation of unnecessary and underutilized personal access tokens. Review the Git Authentication docs for all authentication methods available to you for git clone operations.
Use the URL that you copied to clone the repo in the IDE that you use. For more information, see one of the following articles:
We author pages using Markdown format. Add a Markdown file to your local branch for each page and subpage that you want to add to your wiki.
To add pages at the root of the wiki tree, add a Markdown file at the root of the Git repository.
For each page you want to add, create a Markdown file with the page contents, and then add it under the root folder for your repo.
For the CanaryBuilds team project, it's in the following folder:
C:\Users\UserName\Source\Repos\CanaryBuilds.wiki
To add pages at the root of the wiki tree, add a Markdown file for each page at the root of the Git repository.
After you added all the pages you want to add at the root, update the .order file at the root. It should have one entry for each Markdown file that is defined at the root. Each entry should match the file title with spaces replaced with a dash.
For example:
Welcome
Roadmap
How-to-contribute
Home
Reference
Create a folder for the parent page, and then add Markdown files for each subpage in the folder.
For example, we added the following files to the How-to-contribute folder. These subpages appear under the How to contribute page in the wiki.
Add a .order file in the folder with the order of the subpages as they should appear in the wiki. To understand the use of the .order file to sequence pages, see Wiki Git repository files and file structure.
For example, the file has the following subpages:
Request-extensions
Licensing
Smoke-test
Coding-guidelines
When you're done with all your updates, push the files to the Git repository.
The added pages and subpages appear immediately in your wiki.
If there are any errors in the process, the pages appear in your wiki with a warning sign.
Events
Mar 17, 11 PM - Mar 21, 11 PM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register nowTraining
Documentation
Create a project wiki to share information - Azure DevOps
Share information with your team and increase collaboration using a built-in team project wiki in Azure DevOps.
Publish Git repo to wiki - Azure DevOps
Maintain Markdown files in a Git code repository and publish them to your team project wiki in Azure DevOps.
Wiki files, structure, and conventions - Azure DevOps
Learn about the file conventions of the Git repository and project wikis in Azure DevOps.