https://github.com/errata-ai/vale-boilerplate

An example repository showcasing how to use Vale.
https://github.com/errata-ai/vale-boilerplate

markdata vale

Last synced: about 1 month ago
JSON representation

An example repository showcasing how to use Vale.

• Host: GitHub
• URL: https://github.com/errata-ai/vale-boilerplate
• Owner: errata-ai
• License: mit
• Created: 2020-01-05T21:15:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T13:34:57.000Z (8 months ago)
• Last Synced: 2024-04-12T20:48:48.995Z (8 months ago)
• Topics: markdata, vale
• Homepage:
• Size: 56.6 KB
• Stars: 26
• Watchers: 5
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vale-boilerplate

This is an repository showcases the basic components of Vale's configuration: a `StylesPath` (`/styles`), a configuration file (`/.vale.ini`), and markup content (this file).

Try it out by running `vale README.md` from your command line.

## Markup

Vale is capable of "understanding" markup, allowing it to intelligently lint prose without generating hundreds of markup-related false positives.

For example, consider the following [`write-good`](https://github.com/btford/write-good) style violations:

> This sentence is extremely good.

When using the `write-good` style, this sentence will generate a warning by default (`'extremely' is a weasel word!`). However, if we format `extremely` as inline code, we will no longer receive a warning:

> This sentence is `extremely` good.

You can also use inline comments to control Vale's behavior:

This also works for code blocks and you can even write rules that only activate in certain sections of markup (e.g., headings or block quotes). See the [documentation](https://docs.errata.ai/vale/scoping) for more information.

This is is another sentence with an error.

## Configuration

Vale's configuration file (`.vale.ini`) needs to define a `StylesPath` directory that contains any styles that you'd like to use:

```text

.

├── .vale.ini

├── LICENSE

├── README.md

└── styles

    └── write-good

        ├── Cliches.yml

        ├── E-Prime.yml

        ├── Illusions.yml

        ├── Passive.yml

        ├── README.md

        ├── So.yml

        ├── ThereIs.yml

        ├── TooWordy.yml

        ├── Weasel.yml

        └── meta.json

```

See the [documentation](https://vale.sh/docs/topics/config) for more information.