Skip to content

Commit 86217f8

Browse files
committed
README: Document mdl and vale
Signed-off-by: Philip Molloy <philip@philipmolloy.com>
1 parent f41141f commit 86217f8

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ This book is written with [mdBook](https://github.com/rust-lang/mdBook).
1515
When installed, run `mdbook serve` and you will get a local webserver.
1616
For more details, please refer to the mdBook documentation.
1717

18+
The book is linted with markdownlint and Vale. Follow the official
19+
documentation to [install
20+
markdownlint](https://github.com/markdownlint/markdownlint?tab=readme-ov-file#installation)
21+
and [install Vale](https://vale.sh/docs/install). Then run `vale sync` to
22+
download the necessary styles.
23+
24+
From the root directory of the repository run `mdl /src/example.md` and `vale
25+
src/example.md`. Add words that trigger false positive spelling errors to
26+
`ci/vale/styles/config/vocabularies/LinuxBoot/accept.txt`.
27+
1828
## Acknowledgments
1929

2030
In alphabetical order:

0 commit comments

Comments
 (0)