This is a preview release.
The Markdown Toolkit is a helpful aid for Vultr Docs authors. The toolkit uses Visual Studio Code, Vale, and some useful Markdown extensions to find common issues when writing documentation. The Vultr Docs editing team uses this toolkit, and authors who write for Vultr Docs may find it helpful. The toolkit is also compatible with code-server.
Vultr uses this as an article screening tool, but it may produce false-positives or fail to detect problems. It's possible to write inferior articles that this toolkit will pass without error. This is not a substitute for a human proofreader.
- code-server: See the code-server installation instructions.
- Visual Studio Code: See the Visual Studio Code installation instructions.
Markdown/: Working folderMarkdown/Vultr Docs Template.md: A template for Vultr Docs authorsstyles/: Vale style rulestests/: Test suite for Vultr styles. See README.md..vale.ini: Vale configuration filecode-server.code-workspace: Workspace for code-servervultr-mdtk.code-workspace: Workspace for Visual Studio Code