Devops Markdown

Working with Markdown files in Visual Studio Code is simple, straightforward, and fun. Besides VS Code's basic editing, there are a number of Markdown specific features that will help you be more productive.

Using VScode with Azure Devops and Terraform. The final step in this process is to start working with Azure DevOps and other repo. But before doing that, Please google about Azure Project and pat token creation that we will need now during clone. Create a Test-Project in Azure DevOps and clone this in VS Code. Run script from actual DevOps repo to regenerate markdown file and save output into wiki repo Commit and push wiki repo using git commandline The last step will only create a new commit if there are actually any changes in the file! And if it does the Azure DevOps team wiki is automatically updated. Convert the markdown release note document, or the whole WIKI, to a PDF and use any of the above options using first my WIKI PDF Exporter Task then another task. I personally favour the 1st and 4th options used together. Attachment to the pipeline and then upload the document to a WIKI.

Markdown extensions

In addition to the functionality VS Code provides out of the box, you can install an extension for greater functionality.

Tip: Click on an extension tile above to read the description and reviews to decide which extension is best for you. See more in the Marketplace.

Markdown preview

VS Code supports Markdown files out of the box. You just start writing Markdown text, save the file with the .md extension and then you can toggle the visualization of the editor between the code and the preview of the Markdown file; obviously, you can also open an existing Markdown file and start working with it. To switch between views, press ⇧⌘V (Windows, Linux Ctrl+Shift+V) in the editor. You can view the preview side-by-side (⌘K V (Windows, Linux Ctrl+K V)) with the file you are editing and see changes reflected in real-time as you edit.

Here is an example with a very simple file.

Tip: You can also right-click on the editor Tab and select Open Preview (⇧⌘V (Windows, Linux Ctrl+Shift+V)) or use the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) to run the Markdown: Open Preview to the Side command (⌘K V (Windows, Linux Ctrl+K V)).

Dynamic previews and preview locking

By default, Markdown previews automatically update to preview the currently active Markdown file:

You can lock a Markdown preview using the Markdown: Toggle Preview Locking command to keep it locked to its current Markdown document. Locked previews are indicated by [Preview] in the title:

Editor and preview synchronization

VS Code automatically synchronizes the Markdown editor and the preview panes. Scroll the Markdown preview and the editor is scrolled to match the preview's viewport. Scroll the Markdown editor and the preview is scrolled to match its viewport:

You can disable scroll synchronization using the markdown.preview.scrollPreviewWithEditor and markdown.preview.scrollEditorWithPreviewsettings.

The currently selected line in the editor is indicated in the Markdown preview by a light gray bar in the left margin:

Additionally, double clicking an element in the Markdown preview will automatically open the editor for the file and scroll to the line nearest the clicked element.

Outline view

The Outline view is a separate section in the bottom of the File Explorer. When expanded, it will show the symbol tree of the currently active editor. For Markdown files, the symbol tree is the Markdown file's header hierarchy.

The Outline view is a great way to review your document's header structure and outline.

Extending the Markdown preview

Extensions can contribute custom styles and scripts to the Markdown preview to change its appearance and add new functionality. Here's a set of example extensions that customize the preview:

Using your own CSS

You can also use your own CSS in the Markdown preview with the 'markdown.styles': []setting. This lists URLs for style sheets to load in the Markdown preview. These stylesheets can either be https URLs, or relative paths to local files in the current workspace.

Devops Markdown Wiki

For example, to load a stylesheet called Style.css at the root of your current workspace, use File > Preferences > Settings to bring up the workspace settings.json file and make this update:

Keep trailing whitespace in order to create line breaks

To create hard line breaks, Markdown requires two or more spaces at the end of a line. Depending on your user or workspace settings, VS Code may be configured to remove trailing whitespace. In order to keep trailing whitespace in Markdown files only, you can add these lines to your settings.json:

Markdown preview security

For security reasons, VS Code restricts the content displayed in the Markdown preview. This includes disabling script execution and only allowing resources to be loaded over https.

When the Markdown preview blocks content on a page, an alert popup is shown in the top right corner of the preview window:

You can change what content is allowed in the Markdown preview by clicking on this popup or running the Markdown: Change preview security settings command in any Markdown file:

The Markdown preview security settings apply to all files in the workspace.

Watch dogs 2 steam. Here are the details about each of these security levels:

Strict

This is the default setting. Only loads trusted content and disables script execution. Blocks http images.

It is strongly recommended that you keep Strict security enabled unless you have a very good reason to change it AND you trust all markdown files in the workspace.

Allow insecure content

Keeps scripts disabled but allows content to be loaded over http.

Disable

Disables additional security in the preview window. This allows script execution and also allows content to be loaded over http.

Snippets for Markdown

There are several built-in Markdown snippets included in VS Code - press ⌃Space (Windows, Linux Ctrl+Space) (Trigger Suggest) and you get a context specific list of suggestions.

Tip: You can add in your own User Defined Snippets for Markdown. Take a look at User Defined Snippets to find out how.

Compiling Markdown into HTML

VS Code integrates with Markdown compilers through the integrated task runner. We can use this to compile .md files into .html files. Let's walk through compiling a simple Markdown document.

Step 1: Install a Markdown compiler

For this walkthrough, we use the popular Node.js module, markdown-it.

Note: There are many Markdown compilers to choose from beyond markdown-it. Pick the one that best suits your needs and environment.

Step 2: Create a simple MD file

Open VS Code on an empty folder and create a sample.md file.

Note: You can open a folder with VS Code by either selecting the folder with File > Open Folder or navigating to the folder and typing 'code .' at the command line.

Place the following source code in that file:

Step 3: Create tasks.json

The next step is to set up the task configuration file tasks.json. To do this, run Terminal > Configure Tasks and click Create tasks.json file from templates. VS Code then presents a list of possible tasks.json templates to choose from. Select Others since we want to run an external command.

This generates a tasks.json file in your workspace .vscode folder with the following content:

To use markdown-it to compile the Markdown file, change the contents as follows:

Tip: While the sample is there to help with common configuration settings, IntelliSense is available for the tasks.json file as well to help you along. Use ⌃Space (Windows, Linux Ctrl+Space) to see the available settings.

Step 4: Run the Build Task

Since in more complex environments there can be more than one build task we prompt you to pick the task to execute after pressing ⇧⌘B (Windows, Linux Ctrl+Shift+B) (Run Build Task). In addition, we allow you to scan the output for compile problems. Since we only want to convert the Markdown file to HTML select Never scan the build output from the presented list.

At this point, you should see an additional file show up in the file list sample.html.

If you want to make the Compile Markdown task the default build task to run execute Configure Default Build Task from the global Terminal menu and select Compile Markdown from the presented list. The final tasks.json file will then look like this:

Automating Markdown compilation

Let's take things a little further and automate Markdown compilation with VS Code. We can do so with the same task runner integration as before, but with a few modifications.

Step 1: Install Gulp and some plug-ins

We use Gulp to create a task that automates Markdown compilation. We also use the gulp-markdown plug-in to make things a little easier.

We need to install gulp both globally (-g switch) and locally:

Note: gulp-markdown-it is a Gulp plug-in for the markdown-it module we were using before. There are many other Gulp Markdown plug-ins you can use, as well as plug-ins for Grunt.

You can test that your gulp installation was successful by typing gulp -v. You should see a version displayed for both the global (CLI) and local installations.

Step 2: Create a simple Gulp task

Open VS Code on the same folder from before (contains sample.md and tasks.json under the .vscode folder), and create gulpfile.js at the root.

Place the following source code in that file:

What is happening here?

  1. We are watching for changes to any Markdown file in our workspace, i.e. the current folder open in VS Code.
  2. We take the set of Markdown files that have changed, and run them through our Markdown compiler, i.e. gulp-markdown-it.
  3. We now have a set of HTML files, each named respectively after their original Markdown file. We then put these files in the same directory.

Step 3: Run the gulp default Task

To complete the tasks integration with VS Code, we will need to modify the task configuration from before to run the default Gulp task we just created. You can either delete the tasks.json file or empty it only keeping the 'version': '2.0.0' property. Now execute Run Task from the global Terminal menu. Observe that you are presented with a picker listing the tasks defined in the gulp file. Select gulp: default to start the task. We allow you to scan the output for compile problems. Since we only want to convert the Markdown file to HTML select Never scan the build output from the presented list. At this point, if you create and/or modify other Markdown files, you see the respective HTML files generated and/or changes reflected on save. You can also enable Auto Save to make things even more streamlined.

If you want to make the gulp: default task the default build task executed when pressing ⇧⌘B (Windows, Linux Ctrl+Shift+B) run Configure Default Build Task from the global Terminal menu and select gulp: default from the presented list. The final tasks.json file will then look like this:

Devops Markdown Tools

Step 4: Terminate the gulp default Task

The gulp: default task runs in the background and watches for file changes to Markdown files. If you want to stop the task, you can use the Terminate Task from the global Terminal menu.

Next steps

Read on to find out about:

  • CSS, SCSS, and Less - Want to edit your CSS? VS Code has great support for CSS, SCSS, and Less editing.

Common questions

Is there spell checking?

Not installed with VS Code but there are spell checking extensions. Check the VS Code Marketplace to look for useful extensions to help with your workflow.

Does VS Code support GitHub Flavored Markdown?

No, VS Code targets the CommonMark Markdown specification using the markdown-it library. GitHub is moving toward the CommonMark specification which you can read about in this update.

In the walkthrough above, I didn't find the Configure Task command in the Command Palette?

You may have opened a file in VS Code rather than a folder. You can open a folder by either selecting the folder with File > Open Folder or navigating to the folder and typing 'code .' at the command line.

-->

Azure DevOps Services Azure DevOps Server 2020 Azure DevOps Server 2019 TFS 2018

In this quickstart, learn how to do the following tasks:

  • Open Wiki
  • 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

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

By publishing your Markdown files to a wiki, you gain the following 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

For for information about managing 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 article. 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.
  • You must have enabled Azure Repos service for your project.
  • 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 Contribute to publish code as wiki. By default, this permission is set for members of the Contributors group.
  • Anyone who has permissions to contribute to the Git repository can add or edit wiki pages.

Open Wiki

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

Choose Overview > Wiki.

If you need to switch your team project, choose Azure DevOps to browse all team projects and teams.

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.

Devops
  1. Select Publish code as Wiki.

    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.

    If you've already provisioned a team project wiki, from the context menu for Wikis, choose Publish code wiki.

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

    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.

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

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

    • 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 subfolder defined within the published folder, even if it doesn't contain any Markdown files.

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

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.

Note

You're limited to publishing 10 branches as code wikis.

For the Wiki that's 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.

You can publish a Git repository to a wiki with the az devops wiki create command. To get started, see Get started with Azure DevOps CLI. Run this command when you maintain Markdown files in an existing Git repo and you want to publish them to a wiki.

Note

You can't publish code as Wiki if your project doesn't have a Git repository already defined. If necessary, create a new Git repo, and then return to this page.

Parameters

  • mapped-path: (Required for the codewiki type). Mapped path of the new wiki. For example, you can specify '/' to publish from the root of the repository.
  • name: Name of the new wiki.
  • org: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up using git config. Example: --org https://dev.azure.com/MyOrganizationName/.
  • project: Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up using git config.
  • repository: (Required for the codewiki type). Name or ID of the repository to publish the wiki from.
  • type: Type of wiki to create. The accepted values are projectwiki (default) and codewiki.
  • version: (Required for the codewiki type). Repository branch name to publish the code wiki from.

Note

For Azure DevOps Server 2020, you can use the following command to set the default server instance, collection, and project.
az devops configure --defaults organization=https://ServerName/CollectionName project=ContosoWebApp

Example

The following command creates a codewiki named 'My New Wiki' published from the MyRepo repository. The wiki is published in the wikis folder in the main branch and the result is shown in table format.

Azure DevOps CLI commands aren't supported for Azure DevOps Server 2019 and earlier versions.

Edit, rename, or delete pages

  1. To edit, rename, or delete a page, open Repos>Files or Code>Files.

  2. Choose the page you want, select Actions, and then choose the operation that you want.

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, select Cancel. For details about supported Markdown features, see Syntax guidance for Markdown usage.

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

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

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. Choose Rename to rename the file accordingly.

For example, here we rename new-home-page.md to New-Home-Page.md. This page appears in the TOC with the label, 'New Home Page'.

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've included the file in an .order file, then delete its entry from the .order file. To learn more, jump to Change the page sequence, add, or update an .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 subfolder from the web portal
  • Upload files to a root folder or subfolder
  • 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 for your published repo to review the changes.

Add a page from the web portal

  1. From Repos>Files or Code>Files for the published repo, select Actions, and then choose File.

  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. 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 appears in the TOC as Page 4, add a file named Page-4.md.

  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. Select Actions, and then choose Upload file(s).

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

Add a parent page and subpages

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 subpage in the folder.

  2. Add all the files you want as subpages 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 subpages 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. 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 but without the .md file type. Titles are case-sensitive, so the entry should match the case used in the file name.

For example:

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 you select Wiki within the web portal.

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

For example, enter the page name into the first line:

Promote folder to page

For a folder to be a page as well, there should be a markdown file with the same name as the folder as a sibling to the folder, meaning both the folder and the md file of the same name should lie next to each other.

Displayed in the following example, Test has both a folder and an md file, which creates a hierarchy within the Wiki tree.

Next steps