Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Vale configuration example #951

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/sources/review/lint-prose/_index.md
Original file line number Diff line number Diff line change
@@ -99,13 +99,12 @@ If you manually install Vale, you must configure your system to add Vale to your

1. Create a `.vale.ini` file in your home directory or in a working directory with the following contents:

```bash
```ini
MinAlertLevel = suggestion
StylesPath = /<PATH TO WRITERS TOOLKIT REPOSITORY>/vale
Packages = Grafana, https://github.com/errata-ai/Hugo/releases/download/v0.2.0/Hugo.zip
jdbaldry marked this conversation as resolved.
Show resolved Hide resolved

[*.md]
[*]
BasedOnStyles = Grafana
TokenIgnores = (<http[^\n]+>+?), \*\*[^\n]+\*\*
```

Replace _`<PATH TO WRITERS TOOLKIT REPOSITORY>`_ with the full path to your checkout of the Writer's Toolkit repository.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Replace _`<PATH TO WRITERS TOOLKIT REPOSITORY>`_ with the full path to your checkout of the Writer's Toolkit repository.
Replace _`<PATH TO WRITERS TOOLKIT REPOSITORY>`_ with the full path to your checkout of the Writers' Toolkit repository.

Loading