A Vale-compatible style for technical writers documenting open source software and for anyone writing about Open Source. The style guide closely follows the SUSE Documentation Style Guide and is developed by the SUSE Documentation Team.
The supplied rules perform the following checks:
The following installation procedure has been tested on Linux Mint and openSUSE.
wget https://github.com/errata-ai/vale/releases/download/v2.20.0/vale_2.20.0_Linux_64-bit.tar.gz
test -d ~/vale || mkdir ~/vale
tar xvf vale*.tar.gz -C ~/vale
vale
to PATH
by adding the directory to .bashrc and reload it:
echo 'export PATH=~/vale:"$PATH"' >> .bashrc
source ~/.bashrc
Instead of ~/vale, you can move the binary to any directory that is in $PATH
.
vale is widely packaged by the distribution providers, so install it for your distribution if provided in a recent enough version. Please check the packaging status:
For example in openSUSE Leap 15.5 or newer, vale
can be installed by issuing:
zypper install vale
Install Brew:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Install Vale:
brew install vale
mkdir ~/styles
cd ~/styles && git clone https://github.com/openSUSE/suse-vale-styleguide.git
Create a configuration file in your home directory:
nano ~/.vale.ini
Add the following configuration:
StylesPath = styles
MinAlertLevel = suggestion
[asciidoctor]
experimental = YES
[*{xml,adoc,md}]
BasedOnStyles = common
StylesPath = styles
MinAlertLevel = suggestion
[asciidoctor]
experimental = YES
[*.xml]
Transform = /usr/share/xml/docbook/stylesheet/suse2022-ns/xhtml/docbook.xsl
BasedOnStyles = common, docbook
[*.adoc]
BasedOnStyles = common, asciidoc
[*.{xml,adoc,md}]
BasedOnStyles = common
StylesPath = styles
MinAlertLevel = suggestion
[asciidoctor]
experimental = YES
[*.xml]
Transform = /usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl
BasedOnStyles = common, docbook
[*{xml,adoc,md}]
BasedOnStyles = common
In VS Code, install the Vale +VS Code extension. In VSCodium, install Vale +VS Code extension.
In VS Code or VSCodium, choose File > Preferences > Settings and specify the path to the Vale binary (for example, /usr/local/bin/vale) under Vale > Vale CLI: Path.
Please report bugs and issues in the Issues section.
If you've found an error, or you have a suggestion for improvement, open an issue in the Issues section.
To add a new feature or fix issues yourself, proceed as follows.
git checkout -b new-feature
command.git commit -am 'Add a new feature'
command to commit changes.git push origin new-feature
command.