README.adoc

Vale style for Eclipse Che documentation and blog

Table of Contents

• Adding the CheDocs Vale style to your project

This repository hosts the CheDocs Vale style.

This style has additional rules to the RedHat Vale style, intended for:

• Eclipse Che documentation Git repository

• Eclipse Che blog Git repository

Adding the CheDocs Vale style to your project

Procedure

1. Reference the CheDocs Vale package in your Vale configuration file:

   .vale.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

2. Synchronize your Vale packages:

   $ vale sync

3. Run vale on your files:

   $ vale .

Additional resources

• Consider adopting and adapting our Vale configuration file.

• Consider adopting the GitHub Action for Vale.