Publish a Git repository to a wiki

VSTS

Content that you already maintain in a Git repository can be published to a wiki. For example, content written to support a software development kit (SDK), product documentation, or README files can quickly be published to a wiki. Multiple wikis can be published within a single team project.

By publishing your markdown files to a wiki, you gain these benefits:

  • Organize the content into a hierarchical page structure
  • Table of contents that readers can browse and filter
  • Publish new versions of the content
  • Manage content in the same way you manage your code base
  • Readers can search the wiki easily using the Wiki search feature

Use this topic to learn how to:

  • Open the Wiki hub
  • Publish a Git repo to a wiki
  • Edit pages of a published wiki
  • Add pages to a published wiki
  • Change the page sequence of a published wiki
  • Make a page the wiki home page

In order to perform these steps, you'll want to understand the underlying structure of your wiki Git repo. For details, see Wiki Git repository files and file structure. To understand how to manage the different wiki types, see Differences between provisioned wiki and publish code as wiki.

Tip

You can add and edit content you've published to a wiki using the steps outlined in this topic. Or, you can also work offline and update wiki content in the same way you collaborate on code through a Git repository. For more information, see Update wiki pages offline.

Prerequisites

  • You must have a team project. If you don't have a team project yet, create one in VSTS.
  • You must have a Git repository defined in your team project. Ideally, this repository contains at least one markdown file which you want to publish to your wiki. If you need to add a Git repository, see Create a new Git repo in your project.
  • You must have the permission Create repository to publish code as wiki. By default, this permissions is set for members of the Project Administrators group.
  • Anyone who has permissions to contribute to the Git repository can add or edit wiki pages. Anyone with access to the team project, including stakeholders, can view the wiki.

Open the Wiki hub

Begin by connecting to your project using a supported web browser and choose the Wiki hub.

Open Wiki hub

  • If you need to switch your team project, click the VSTS icon to browse all team projects and teams.
  • If you don't see the Wiki hub, your screen size may be reduced. Click the three dots (elipses), then choose Wiki>Wiki.

Open wiki hub, reduced screen size

Publish a Git repository to a wiki

Choose this option when you maintain markdown files in an existing Git repo and you want to publish them to a wiki.

  1. On the Wiki landing page, choose Publish code as Wiki.

    Create wiki, publish existing repo markdown files

    Note

    The Publish code as Wiki option won't appear if your project doesn't have a Git repository defined. Create a new Git repo and then return and refresh this page.

    Or, if you have already provisioned a team project wiki, from the context menu for Wikis, choose the Publish code as wiki menu option.

    Publish code as wiki menu option

  2. Choose the repository, branch, and folder that contain the markdown files and name the wiki repository. The Git repo must reside within the team project.

    Create wiki, publish existing repo markdown files

    Specify the root of the repository when you want to publish all markdown files in the repository to your wiki.

  3. Choose Publish. The wiki repo is populated with the markdown files and folders included within the repo you selected. If a sub-folder does not contain a markdown file, it will not show up in the Wiki.

    For example, the following image shows the published repo for the files contained in the azure-docs-sdk-node repository selected in Step 2.

    Published wiki from existing repo markdown files

    The wiki Table of Contents (TOC) contains the following:

    • Each markdown file (file type=.md) defined in the repo/branch/folder is listed in alphabetical order, the TOC title is derived from the markdown file name
    • A parent page for each sub-folder defined within the published folder, even if it doesn't contain any markdown files.

      And here is an image of the contents of the azure-docs-sdk-node repository.

      Repo with markdown files published to wiki

The head of the Git repo branch is now mapped to the wiki. Any changes made within the branch and selected folder(s) are automatically reflected in the Wiki. There are no other workflows involved.

With the Wiki provisioned with the markdown files you've added, you can now add or edit pages in the same way that you maintain code in your Git repository.

Edit, rename, or delete pages

  1. To edit, rename, or delete a page, open the Code hub, Files page.

  2. Choose the page you want, open the actions icon and choose the operation you want.

    Edit, rename, or delete wiki content

Note

You can manage your wiki repo in the same way you manage any other Git repo by defining branch policies on the branch that you selected to publish to a wiki. However, without any policies defined, you can make changes and push them directly to the branch from your web portal or from a client.

Edit a page

You can use the links available in edit mode to preview your changes or highlight changes made from the previous version. To discard your changes, simply click Cancel. For details about supported markdown features, see Syntax guidance for Markdown files, widgets, wikis, and pull request comments.

  1. When finished with your updates, choose Commit, and then fill in the Commit dialog form.

    Commit dialog

  2. The system will automatically present you with a link to create a pull request. You can ignore this message when you are directly editing the wiki branch.

    Create a pull request link

Tip

When you change the name or case of a file, you'll want to update the .order file to reflect the change. To learn more, jump to Change the page sequence, add or update a .order file.

Rename a page

All pages that you want to appear in the TOC must have .md as their file type. If you forget that, or want to change the title case or title that appears in the TOC, choose the Rename option to rename the file accordingly.

For example, here we rename new-home-page.md to New-Home-Page.md. This page will now show up in the TOC with the label, "New Home Page".

Rename Commit dialog

Page titles are case sensitive and must be unique within the folder, and 235 characters or less. For other title restrictions, see Page title naming restrictions.

Delete a page

Any markdown files that you don't want to appear in the wiki, you can delete from the published folder. If you have included the file in a .order file, then delete it's entry from the .order file. To learn more, jump to Change the page sequence, add or update a .order file.

Add a page or pages

You can add pages to your published wiki as follows:

  • Add a file to a root folder or sub-folder from the web portal
  • Upload files to a root folder or sub-folder
  • Add or update a .order file to specify the page sequence in the wiki TOC

Each update you make requires you commit your changes to the repository. You can then refresh your Wiki hub for your published repo to review the changes.

Add a page from the web portal

  1. From the Code>Files page for the published repo, open the actions icon and choose File.

    Filter wiki TOC

  2. Enter a name for the page, make sure to specify the .md file type. The file name should correspond to the page title that you want to appear in the TOC, with dashes in place of spaces. 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.

    For example, to add a page that will appear in the TOC as Page 4, add a file named Page-4.md.

    Filter wiki TOC

  3. Enter the contents of the page. For details about supported markdown features, see Syntax guidance for Markdown files, widgets, wikis, and pull request comments.

  4. When done, choose Commit, and then fill in the Commit dialog form.

Upload files to a folder

  1. If you have existing content already defined, you can upload it into a folder. Open the actions icon and choose Upload file(s).

    Upload files to a folder option

  2. Fill in the Commit dialog form, selecting the folder and files you want to upload.

    Commit dialog for uploading files

Add a parent page and sub-pages

To add a parent page, you'll first add a markdown file at the root folder level and then add a folder with the same label.

  1. To add a folder, choose Folder, and then fill in the New folder dialog form. Specify at least one file to correspond to a sub-page in the folder.

    Create folder dialog

  2. Add all the files you want as sub-pages to the folder.

Add or update a .order file

The last step when adding files or folders to the wiki repo is to add or update the .order file of the updated folders to reflect the sequence of pages you want to show in the TOC. For details, see Change the page sequence, add or update a .order file.

Tip

Files that you upload or add won't show up in the wiki TOC until you add or update the .order file to include them.

Change the page sequence, add or update a .order file

Each .order file defines the sequence of pages contained within a folder. The root .order file specifies the sequence of pages defined at the root level. And for each folder, a .order file defines the sequence of sub-pages added to a parent page.

You can add a .order file in the same way as you add any file from the Code>Files page. Simply name the file .order.

Then, edit the contents of the file to reflect the sequence of markdown files contained within the folder. Each entry should mirror the file name with dashes replaced with a space and without the .md file type. Titles are case sensitive, so the entry should match the case used in the file name.

For example:

README
page-2
page-3
Page-4
Misc content

Set a home page

By default, the first file that appears at the root within alphabetical order is set as the wiki home page. The home page opens whenever someone clicks Wiki within the web portal or clicks the home link home icon.

You can change the home page by setting the page sequence within the root .order file.

For example:

New Home Page
README
page-2
page-3
Page-4
Misc content

Try this next