Skip to content

Vale style for Eclipse Che Documentation and related projects

License

Notifications You must be signed in to change notification settings

eclipse-che/che-docs-vale-style

Repository files navigation

Vale style for Eclipse Che documentation and blog

This repository hosts the CheDocs Vale style.

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

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