Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 761 Bytes

vale.md

File metadata and controls

26 lines (16 loc) · 761 Bytes

Using vale.sh

Vale is a natural language linter that helps writers improve their prose. Opni uses it to standardize markdown files.

Installing vale

Refer to: https://vale.sh/docs/vale-cli/installation/

The vale configuration file used for Opni is located at .vale.ini

After installing, run vale sync to fetch the styles specified in the configuration file. This only needs to be run once.

Usage

Single file: vale path/to/file.md

Multiple files: vale path/to/directory/

Docker

If you don't want to install vale, you can run it in a docker container by mounting the Opni source after installing the packages .vale.ini:

docker run -v $(pwd):/opni jdkato/vale:v2.22.0 --config /opni/.vale.ini /opni/<file>