Vale Server's user interface (UI) consists of two parts: a native desktop application and a web-based dashboard.
To access the main application, click on its menu icon (right-click on Windows):
And then click the Preferences... option from the context menu.
Notify me about style updates: If checked, you'll receive a desktop notification (on application start) if there are any available updates to your styles.
Compatibility Mode: If checked, clients (for example, VS Code and Atom) will check documents according to their local Vale configuration files whenever possible.
Projects allow you to manage multiple Vale configuration files in one place. Each project has a name (the left panel) and an associated configuration file (the right panel):
To create a new Project, click "Add" and then double-click the new project to give it a name:
You can now edit the configuration file on the right to customize the new project. To remove a project, click its name and then click the "Remove" button.
After you've created and configured your projects, you can switch between them by choosing Select Project from the menu bar:
Additionally, each project has an associated Vocabulary that you can manage via the Dashboard.
The Styles page provides quick access to all your installed styles. You can add your own styles by choosing Browse Styles... from the menu bar and then copying the relevant files.
The Advanced page allows you to configure the port that Vale Server will listen on. You'll need to restart the server for the change to take effect.
The dashboard provides a web-based interface for managing your Vale-related assets.
To open your dashboard, click the Open Dashboard... option from the context menu.
Vocabulary entries belong to one of two groups:
Preferred: Entries marked as
conditionalrules in all your active styles.
Do not use: Any use of an entry marked as
Do not usewill raise an error.
To manually edit a Vocabulary file, click Browse Styles... from the context
menu and then navigate to the
/Vocab/<project name> directory.
The Styles page of the dashboard allows you to browse, install, and update third-party styles. These styles are open-source and maintained by the community of Vale Server users.
See the dedicated repository to learn more.