diff --git a/pages/common/vale.md b/pages/common/vale.md new file mode 100644 index 000000000..9e7e336a5 --- /dev/null +++ b/pages/common/vale.md @@ -0,0 +1,28 @@ +# vale + +> Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc. +> More information: . + +- Check the style of a file: + +`vale {{file}}` + +- Check the style of a file with a specified configuration: + +`vale --config='{{path/to/.vale.ini}}' {{file}}` + +- Output the results in JSON format: + +`vale --output=JSON {{file}}` + +- Check style issues at the specific severity and higher: + +`vale --minAlertLeve={{suggestion|warning|error}} {{file}}` + +- Check the style from stdin, specifying markup format: + +`cat {{file.md}} | vale --ext=.md` + +- List the current configuration: + +`vale ls-config`