VSTS | TFS 2018
Feature availability: The built-in wiki is in Preview and available for VSTS at this time. You enable this feature for a team project from the Preview features option from your profile menu.
If you were using the Wiki Marketplace extension, you can migrate your existing pages to the new team project wiki.
Each team project has a wiki associated with it. Use it to share information with your team members and stakeholders to understand, use, and contribute to your project.
Learn how to:
Create your first wiki page
Add, edit, delete, and reorder pages
Recover deleted pages
Change the page referenced as the wiki home page
Review a wiki page revision history
Filter wiki pages
Edit wiki pages offline
Create your wiki and first wiki page
Enable the Wiki by clicking your profile menu and choosing Preview Features. Select the team project and then turn on the Wiki feature.
To create your first wiki, open your web portal and click Wiki in the top row (click ... if it doesn't show). You need to be a member of the Contributors group to add and edit the wiki.
Click Create Wiki to provision a new git repository that will store all your wiki pages and related artifacts. The repository is automatically labeled TeamProjectName.wiki.
The TeamProjectName.wiki doesn't appear in the dropdown menu of repositories in the Code hub, nor in the list provided in the team project administration context, Version Control page.
However, you can navigate to it from the URL
A new page opens in which you can specify a title and add content. You author pages using markdown format. Also, you can use the format pane for rich-text formatting and to insert images, attachments, and links as well as add rich formatted text.
To validate your changes, click Preview. When you're finished with your edits, click Save.
Add, edit, delete, and reorder wiki pages
To add another page, click New page, or you can add a subpage by opening the context menu of an existing page and clicking Add sub-page.
You must specify a unique title of 235 characters or less. Page titles are case sensitive. For other title restrictions, see Page title naming restrictions.
Each new page you add is added to the root of your current hierarchy context. Each sub-page you add is added within the folder labeled the same as the parent topic.
Edit and delete wiki pages
To edit an existing Wiki page, open the page and click Edit page, or open it's context menu and click Edit.
To delete a page, open it's context menu from the tree view of pages and click Delete. Confirm the delete in the dialog box that opens.
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 these operations:
- Change the parent-child relationship of a page
- Change the order of the page within the hierarchy
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.
Make a page the wiki home page
By default, the first page you added when you created the wiki is set as the wiki home page. You can change this if a new page becomes more relevant. The home page opens whenever someone clicks Wiki within the web portal or clicks the home icon.
To reset the home page, open the context menu of the page and click Set as wiki homepage.
View wiki page revision history
To view the revision history of a page, click the Revisions link provided on each page.
Revisions catalog who made the change along with the revision message, date, and version or commit ID. To view details of a revision, click the message or version (commit) link.
Similar to any git file revision, the revision details page provides a side-by-side diff view or the inline diff view. You can also click Preview to view the content of the page as of the specific revision.
To return to the wiki, click Wiki from the top row of your web portal.
Recover a deleted wiki page
To recover a deleted page, revert the commit associated with the deleted file. To find the commit, open the Code>History page for the TeamProjectName.wiki repository.
Filter wiki pages
The filter feature allows you to quickly find a wiki page after the number of pages has grown to the hundreds or thousands.
To find a page, enter a title or keyword into the Filter pages box.
- Syntax guidance for Markdown files, widgets, wikis, and pull request comments
- Get Started with Git
- Git repository permissions
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.
|File name||The fully qualified page path should not exceed 235 characters.|
|Uniqueness||Page titles are case sensitive and must be unique within the wiki hierarchy.|
|File size||Must not exceed the maximum of 15 MB|
|Attachment file size||Must not exceed the maximum of 10 MB|
Clone your wiki repo and edit wiki pages offline
To update your wiki pages offline, clone your wiki repository and add or edit pages much the same way you develop code in a git repo. You can then push your changes to your working branch and merge them with the master branch of the wiki repository.
- The wiki repo corresponds to ProjectName.wiki
- The master branch corresponds to WikiMaster.
The wiki repository contains the following files and folders:
- A file for each page entered at the root level
- A folder for each page that contains subpages
- A root .order file which specifies the sequence of pages defined at the root level
- A .order file within each folder; this file maintains the order of subpages added to the parent page
Each .order file defines the sequence of folders and pages contained within the folder.
When you add pages offline, you must update the .order file with the titles of the added pages.
To get the URL to clone your wiki, open the More menu and click Clone Wiki.
From the Clone repo dialog, click Copy clone url to clipboard.
Add or edit files, keeping in mind these guidelines or requirements:
- Add the file name to the .order file for any pages you add to the root folder or subfolder.
- To create a page hierarchy with parent and child pages, create a folder with the same name as the pareent page. For example, add a folder labeled "Home-Page" to support the parent page labeled "Home-Page.md", and then add all child pages within that folder.
- Add an entry in the root .order file to support any child pages within the hierarchy.
When done, push the files to the git repository.