williamscraigm / vscode-docs-authoring

VSCode extension that provides markdown authoring assistance to docs.microsoft.com contributors

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

vscode-docs-authoring

This repo contains the Learn Authoring Pack VS Code extension, which is an extension pack containing multiple Markdown and YAML helper extensions. The main goal is to provide authoring assistance for contributing to learn.microsoft.com. This repo is our feedback mechanism allowing the community to report issues. We are not accepting outside contributions, but would like to continue improving the existing extensions supported in the Learn Authoring Pack.

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:

  • Docs Markdown, which provides Markdown authoring assistance, including support for inserting custom Markdown syntax specific to docs.microsoft.com. The rest of this readme provides details on the Docs Markdown extension.
  • Docs Preview, which uses the docs.microsoft.com CSS for more accurate Markdown preview, including custom Markdown.
  • Docs YAML, which validates Docs .yml files against the appropriate YAML schemas.
  • Docs Images, which compresses and resizes images.
  • Docs Article Templates, which allows users to apply Markdown skeleton content to new files.
  • Docs Scaffolding, which automatically generates Learn modules based on standard patterns and automates renaming, inserting, deleting, and reordering units.
  • markdownlint, a popular linter by David Anson.

About

VSCode extension that provides markdown authoring assistance to docs.microsoft.com contributors

License:MIT License


Languages

Language:JavaScript 100.0%