Docs Authoring Pack
The Docs Authoring Pack provides a series of extensions to help docs.microsoft.com authors work better and more efficiently. You can read more about all of the Docs Authoring Pack features here in the overview guide. The Docs Authoring Pack provides the following extensions to help author content for docs.microsoft.com:
How to use the Docs Markdown extension
To access the Docs Markdown Authoring menu, type ALT + M. 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.
You can also access the Docs commands from the VS Code command palette by hitting F1 and typing to filter. All the Docs commands begin with "Docs":
Prerequisites and assumptions
To accurately insert relative links, images, and other embedded content with Docs Markdown, you must have your VS Code workspace scoped to the root of your cloned OPS repo. Some syntax supported by the extension, such as alerts and snippets, are custom Markdown for Docs, and will not render correctly unless published via Docs.
For more information about the Docs Markdown commands, see the Docs Markdown readme.
How to use Docs Images extension
To access the Docs Images menu, right click on a folder or individual image file. Select Compress all images in folder or Compress image from the context menu.
For more information about the Docs Images extension, see the Docs Images readme.
How to use Docs YAML extension
Intellisense is automatically triggered by CTRL + Space to get what you can type.
For more information about the Docs YAML commands, see the Docs YAML readme.
How to use Docs Preview extension
You can open Docs Preview by opening a markdown document and clicking on the preview button. One opens the preview in your current window, and the other opens the markdown preview to the side. Alternatively you can hit Alt + M and select
For more information about the Docs Preview commands, see the Docs Preview readme.
How to use Docs Linting extension
Docs Authoring Pack also supports comes with custom linting rules to aid in catching errors many run into when contributing to docs. This should automatically work with Docs Authoring Pack, and you will see the output in the "Problems" pane.
For more information about the Docs Linting commands, see the Docs Linting readme.
Docs Markdown keyboard shortcuts and toolbar
How to assign keyboard shortcuts
Default keyboard shortcuts are available for some commands, as noted in the table above. You can override them, or add shortcuts for other commands, using the VS Code keyboard shortcut mappings.
See Keybindings in the VS Code docs for more information.
How to show the markdown toolbar
Users of the pre-release version of the extension will notice that the authoring toolbar no longer appears at the bottom of the VS Code window when the Docs Markdown extension is installed. This is because the toolbar took up a lot of space on the VS Code status bar, and did not follow best practices for extension UX, so it is deprecated in the new extension. However, you can optionally show the toolbar by updating your VS Code settings.json file as follows:
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.