Skip to content

Commit

Permalink
Update docs/document.md
Browse files Browse the repository at this point in the history
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
devtobi and coderabbitai[bot] authored Jan 10, 2025
1 parent d6d49d6 commit 6521518
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you want a preview of the documentation while writing, use the `npm run dev`
To maintain high quality in your documentation, we provide a script to run various checking tools.

By executing `npm run lint`, the tool [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) will be used to check validity of your markdown files.
The configuration file we provide (`.markdownlint.jsonc`) is almost default, but feel free adjust it to your own needs. Please check out the official documentation of [markdownlint](https://github.com/DavidAnson/markdownlint#optionsconfig) in this case.
The configuration file we provide (`.markdownlint.jsonc`) is almost default, but feel free to adjust it to your own needs. Please check out the official documentation of [markdownlint](https://github.com/DavidAnson/markdownlint#optionsconfig) in this case.
For all other files (e.g. the Vitepress configuration file) [Prettier](https://prettier.io/) and its respective configuration file (`.prettierrc`) is used.

A lot of the reported errors can be automatically fixed by running `npm run fix`.
Expand Down

0 comments on commit 6521518

Please sign in to comment.