VSTS Wiki As Code Util Extension
Welcome to the VSTS Wiki as code extension.
This extension provides helpful functions for working with VSTS Wikis that have been published from code.
It includes functions that make it easy to add files or images to a wiki by automatically saving them to a library folder and inserting the associated markdown on your page. There are also functions to assist with consistency when adding pages or promoted sections.
Please do provide feedback and feature requests in the Visual Studio Marketplace:
VS Marketplace - Hestan - VSTS Wiki Util - Q & A
VS Marketplace - Hestan - VSTS Wiki Util - Rating & Review
Prerequisites and Assumptions
You have published your code as a VSTS wiki
Your wiki is contained within a folder in your repository (default setting expects this folder to be called 'wiki' but this can be overridden)
Your wiki library folder containing your referenced images and files sits alongside the wiki folder in your directory structure (default setting expects this folder to be called 'wikilib' but this can be overridden). This folder will be created if it does not already exist.
How to Use the Extension
To access the menu, type SHIFT+ALT+M while editing a Wiki markdown page.
You can click or use up/down arrows to select the function you want, or type to start filtering, then hit ENTER when the function you want is highlighted in the menu. The following are available:
| Function |
Command |
Description |
| Add Image |
addImage |
Prompts to input alternative text for the link and to select an image file. Creates a directory structure that mirrors the path to the page the image is to be added to. Copies the file into the Wiki Library in a folder named the same as the page markdown file. Adds a line of markdown into the page that has a relative path link to the image file and includes the alternative text. |
| Add File |
addFile |
Prompts to input alternative text for the link and to select a file. Creates a directory structure that mirrors the path to the page the image is to be added to. Copies the file into the Wiki Library in a folder named the same as the page markdown file. Adds a line of markdown into the page that has a relative path link to the file and includes the link text. |
| Add Page |
addPage |
Prompts to input the name of the new page and to select a parent directory. Creates a markdown file, in the parent directory, named as the input section name replacing spaces with '-'. |
| Add Section |
addSection |
Prompts to input the name of the new section and to select a parent directory. Creates a folder and markdown file, in the parent directory, named as the input section name replacing spaces with '-'. Then creates and empty .order file in the new folder. |
