- Useful for converting Markdown language into HTML. Supported Platforms. Visual Studio Team Services - aka. Azure DevOps; Team Foundation Server 2015 Update 3 and higher (How to install extensions in TFS) Usage. The extension installs the follow tasks: Transform a single Markdown file To HTML. Parameters: Markdown file path: The path of the input Markdown file.
- Working with teams, areas, and iterations. Open the settings page using the Project settings.
- Now we know how to create a Markdown document we need to learn how to create an Azure DevOps Wiki page. Azure DevOps REST API - Pages According to the documentation Wiki pages are Markdown files that are stored in a Git repository in the backend.
- Azure DevOps Extension for Azure CLI. Contribute to Azure/azure-devops-cli-extension development by creating an account on GitHub.
The two other extensions have been developed by a fellow ALM DevOps Ranger, Richard Fennel. The cross-platform Generate Release Notes based on Release Comparison extension generates a release notes markdown file using the same API calls as the Azure DevOps Pipeline Release UI. It uses a template that allows you to generate professionally.
Contents
- PSDocs
- Azure DevOps REST API - Pages
For a project I was investigating how I could dynamically create Markdown files. I searched the internet and I found the following PowerShell Module from Bernie White a Premier Field Engineer from Microsoft.
PSDocs is a PowerShell module with commands to generate markdown from objects using PowerShell syntax.
According to it’s disclaimer the project is a proof-of-concept but for me it worked great and in these blog post series I’ll explain how you can use this in your Azure DevOps Pipelines to create Markdown Wiki documentation. In part one I start with the basics.
Installation of PSDocs
To install the PSDocs PowerShell module run:
To create a Markdown content object stored running processes in a Markdown table you can use the following example.
In Markdown this will look like this.
Now we know how to create a Markdown document we need to learn how to create an Azure DevOps Wiki page.
According to the documentation Wiki pages are Markdown files that are stored in a Git repository in the backend.
The following web requests creates or edits a wiki page.
Wiki Identifier
One of the needed properties to create the wiki page is the wikiIdentifier. This is the Wiki id or name of the wiki.
We can find the wiki name by going to the Azure DevOps Project and selecting Wiki in the menu.
PowerShell script to create an Azure DevOps Wiki page
With the following script you can create a Wiki page in Azure DevOps using the PSDocs PowerShell module and the Azure DevOps REST API.
If you want to delete the wiki page using the REST API you can use the following command:
Azure Devops Markdown Mermaid
In the next part of this blog post series I want to share how you can use above knowledge to create a wiki from within an Azure DevOps Pipeline.
Hope you enjoyed this blog post.
Azure Devops Markdown Plantuml
References
Markdown Widget Azure Devops
Please enable JavaScript to view the comments powered by Disqus.
Comments are closed.