Our docs have an official new home at https://docs.errata.ai/vale-server/usage.
This page provides a step-by-step guide to getting up and running with Vale Server.
Step 1: Installing a style
The first step you'll need to take before using Vale Server is to install a style.
Installing a pre-made style
To get started, you'll probably want to use one of our community-contributed styles:
Click the Open Dashboard... option from the context menu:
Click Styles from the dashboard sidebar:
Choose a style from the list and click install:
You can click on a style's name to learn more about it.
Installing a custom style
To install a style that hasn't been submitted to the library:
Click the Browse Styles... option from the context menu:
Copy your style into the
Step 2: Creating a project
After you've installed a style (or styles), you need to create a project.
To open the Projects page, click the Preferences... option from the context menu and follow the instructions on creating a new project.
Step 3: Updating your vocabulary
Click the Open Dashboard... option from the context menu.
Select your desired project from the drop-down menu:
Follow the directions for adding terms to your project.
Step 4: Using the clipboard
The Check Clipboard as... option allows you to use your Vale Server configuration anywhere that supports copy-and-paste (for example, web browsers, email clients, content management systems, etc).
To check your content, simply copy it to your clipboard and choose Check Clipboard as... from the menu:
Step 5: Using a client application
Our third-party integrations provide an enhanced experience for certain applications. Click on an application below to learn more.
|Google Docs||Sublime Text||Atom||VS Code||Google Chrome|
Step 6: Creating & testing rules
With Vale Server, you can easily develop and test individual rules for a new or existing style.
The "Run" button will execute the rule (left-hand panel) on the provided text (right-hand panel). The "regex101" button will create a new regex101 session using the compiled rule.