:toc:

Vale style for Eclipse Che documentation and blog

This repository hosts the CheDocs Vale style.

This style has additional rules to the link:https://vale.sh/hub/redhat/[_RedHat_ Vale style], intended for:

• link:https://github.com/eclipse-che/che-docs/[Eclipse Che documentation Git repository]
• link:https://github.com/eclipse-che/blog/[Eclipse Che blog Git repository]

== Adding the CheDocs Vale style to your project

.Procedure . Reference the CheDocs Vale package in your Vale configuration file: + ..vale.ini [source,ini]

StylesPath = .github/styles MinAlertLevel = suggestion

Packages = RedHat, https://github.com/eclipse-che/che-docs-vale-style/releases/latest/download/CheDocs.zip

[*.adoc] BasedOnStyles = RedHat, CheDocs

. Synchronize your Vale packages: + [source,commandline]

$ vale sync

. Run vale on your files: + [source,commandline]

$ vale .

.Additional resources

• Consider adopting and adapting our link:https://github.com/eclipse-che/che-docs-vale-style/blob/main/.vale.ini[Vale configuration file].
• Consider adopting the link:https://github.com/errata-ai/vale-action[GitHub Action for Vale].