Skip to content

Commit

Permalink
v3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Jan 10, 2024
1 parent d476f27 commit a1655c3
Show file tree
Hide file tree
Showing 8 changed files with 5,315 additions and 10,632 deletions.
10 changes: 10 additions & 0 deletions assets/jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"*": [
"../node_modules/mermaid/*"
]
}
}
}
4 changes: 4 additions & 0 deletions config/postcss.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
'alert-link',
'container-xxl',
'container-fluid',
'container-fw ',
...whitelister([
'./assets/scss/components/_alerts.scss',
'./assets/scss/components/_buttons.scss',
Expand All @@ -32,6 +33,9 @@ module.exports = {
'./assets/scss/common/_dark.scss',
'./node_modules/bootstrap/scss/_dropdown.scss',
'./node_modules/katex/dist/katex.css',
'./node_modules/@hyas/doks-core/assets/scss/components/_code.scss',
'./node_modules/@hyas/doks-core/assets/scss/components/_expressive-code.scss',
'./node_modules/@hyas/doks-core/assets/scss/common/_syntax.scss',
]),
],
}),
Expand Down
19 changes: 16 additions & 3 deletions content/en/docs/topics/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ StylesPath = "ci/vale/styles"
(e.g., styles and ignore files\). The path value may be absolute or relative to
the location of the parent `.vale.ini` file.

As of v3.0.0, Vale supports a default `StylesPath`. The location of this path
depends on your operating system:

| OS | Search Locations |
| :------ | :--------------------------------------------------- |
| Windows | `%LOCALAPPDATA%\vale\styles` |
| macOS | `$HOME/Library/Application Support/vale/styles` |
| Unix | `$XDG_DATA_HOME/vale/styles` |

(Run the `vale ls-dirs` command to see the exact locations on your system.)

#### MinAlertLevel

```ini
Expand Down Expand Up @@ -296,9 +307,11 @@ configuration depends on your operating system:

| OS | Search Locations |
| :------ | :--------------------------------------------------- |
| Windows | `%AppData%\vale` |
| macOS | `$HOME/Library/Application Support/vale` |
| Unix | `$XDG_CONFIG_HOME/vale` |
| Windows | `%LOCALAPPDATA%\vale\.vale.ini` |
| macOS | `$HOME/Library/Application Support/vale/.vale.ini` |
| Unix | `$XDG_CONFIG_HOME/vale/.vale.ini` |

(Run the `vale ls-dirs` command to see the exact locations on your system.)

This is different from the other config-defining options (`--config`,
`VALE_CONFIG_PATH`, etc.) in that it's loaded in addition to, rather than
Expand Down
15 changes: 10 additions & 5 deletions content/en/docs/topics/vocab/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Vocab = Some-Name
BasedOnStyles = Vale, MyStyle
```

Each `Vocab` is a single folder (stored at `<StylesPath>/Vocab/<name>/`)
Each `Vocab` is a single folder (stored at `<StylesPath>/config/vocabularies/<name>/`)
consisting of two plain-text files&mdash;`accept.txt` and
`reject.txt`&mdash;that contain one word, phrase, or regular expression per
line.
Expand Down Expand Up @@ -64,15 +64,20 @@ folder structure:
```bash
$ tree styles
├───MyStyle
├───Vocab
│ ├───Blog
│ └───Marketing
├───config
│ └───vocabularies
│ ├───Blog
│ │ ├───accept.txt
│ │ └───reject.txt
│ └───Marketing
│ ├───accept.txt
│ └───reject.txt
└───MyOtherStyle
```

Here, our `StylesPath` (`/styles`) contains two styles (`MyStyle` and
`MyOtherStyle`) and two vocabularies (`Blog` and `Marketing`). You can then
simply reference these entries by their folder name:
reference these entries by their folder name:

```ini title=".vale.ini"
StylesPath = styles
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/vale-cli/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ ENV PATH="/dita-ot-3.6/bin:$PATH"
ENTRYPOINT ["/bin/vale"]
```

## PyPI, npm, ...
## Other options

- [PyPI](https://pypi.org/project/vale/)
- [npm](https://www.npmjs.com/package/@ocular-d/vale-bin)
Expand Down
6 changes: 2 additions & 4 deletions content/en/docs/vale-cli/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,15 @@ be. To put it succinctly, Vale doesn't teach you *how to* write; it’s a tool

This distinction is particularly important to understand because Vale doesn't
offer any of its own advice. Instead, it offers a framework for creating and
enforcing [custom rules][1]. Its approach is much more similar to code linters
than it is to traditional grammar checkers.
enforcing [custom rules][1]. Its approach is much more similar to code linters than it is to traditional grammar checkers.

See "[Introducing Vale, an NLP-powered linter for prose][2]" for a more
detailed explanation.

## Why should you use Vale?

- It will enforce your own style and can go well beyond traditional
writing-related rules. See [GitLab's configuration][5] for an idea of what's
possible.
writing-related rules.

- It understands [markup][4] well, allowing you to write your content in
Markdown, AsciiDoc, reStructuredText, and more, without syntax-related false
Expand Down
Loading

0 comments on commit a1655c3

Please sign in to comment.