This page provides a step-by-step guide to getting up and running with Vale Server.
Installing a style
The first step you'll need to take before using Vale Server is to ensure that you have styles available somewhere on your machine. You have a few options for doing this:
You can use the dashboard to install pre-made style from our community-maintained library.
You can copy or clone your own styles into the default
StylesPath(select Browse Styles... from the context menu).
You can specify a custom
StylesPaththat already contains your styles in a project (see Step 2).
Creating a project
After you've installed a style (or styles), you need to create a project. Click on the Preferences... option from the context menu and follow the instructions on creating a new project.
Using a client application
The final step is to install one of our third-party integrations. These allow you to see suggestions based on your active project while you write.
|Atom||Chrome||Google Docs||Sublime Text||VS Code|
Choosing a mode
Vale Server can run in one of three modes, as described below.
Server: Vale Server will check documents solely based on the active project's configuration.
Compatibility: Vale Server will check documents according to their associated local Vale configuration files while respecting the following override rules:
Any multi-value entry in your project's
BasedOnStyles) will be combined with the remote entry.
Any single-value entry in your project's
MinAlertLevel) will override the remote entry altogether.
Command Line: Vale Server will check documents solely based on the their local Vale configurations.
You can switch between modes through the context menu's
Select Mode option.