README.md

Vultr Markdown Toolkit (MDTK)

MDTK is a helpful aid for authors who write Markdown, consisting of Vale style rules, Vultr vocabulary, a recommended set of Visual Studio Code extensions, and a workspace file that sets the preferred defaults.

How to Install MDTK

1. Install the required components:

   • Visual Studio Code
   • Vale CLI
   • Vale Extension
   • Markdown All in One
   • markdownlint

2. Clone the vultr/vultr-mdtk repository to a folder on your workstation.

3. Open vultr-mdtk.code-workspace with Visual Studio Code. This workspace configures the correct options for Vale and the Markdown extensions.

4. Edit your Markdown files in the Markdown folder. Errors are underlined in red, Warnings in yellow, and Suggestions in blue. You can hover over the alerts for pop-up help.

   

5. Open the Problems tab to view the complete list of errors, warnings, and suggestions.