Writing Extension Pack

(Technical) Writing

Extension Pack to install a list of extensions for writing (API) documentation
VisualStudio | Marketplace »


Report Bug · Request Feature · Changelog

Note 1.2.1 is the latest release for v1!
The next release will be v2. Version 2 contains breaking changes and will be not compatible with v1.
If you want to test v2 and provide feedback, get the vsix file from GitHub.

Table of Contents

• About the Project
• Dependencies
• Included Extensions
• Contributing
• License
• Credits

About

Extension package for VS Code for creating stunning Markdown based documentation.

Dependencies

• vale
• remark
• remark-cli
• remark-preset-lint-recommended
• remark-preset-lint-consistent
• remark-validate-links
• remark-preset-lint-markdown-style-guide

Included Extensions

Code

• Polacode
• Bracket Pair Colorizer 2
• Code Spell Checker
• Highlight Matching Tag
• Indent Rainbow

Git

• GitLens

Markdown

• Markdown Emoji
• Markdown TOC
• Remark
• Remark Lint

Writing

• Word Count
• Highlight Trailing White Spaces
• Read Time
• Vale

OpenAPI

• OpenAPI (Swagger) Editor

Icons

• Material Icon Theme

Themes

• Github Light Theme
• Night Owl

VS-Code

• Settings Sync

Contributing

We are a community effort, and everybody is most welcome!

Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.

License

Distributed under the GPLv2 license.

Credits

• Pronovix