Skip to content

GitLab Vale Rules 1.0.1

Choose a tag to compare

@github-actions github-actions released this 17 Feb 01:04
· 28 commits to main since this release
c99658b

GitLab Vale Rules 1.0.1

This release contains the GitLab documentation style rules for Vale, synced from the official GitLab repository.

What's Included

  • gitlab_base: Core GitLab writing style rules
  • gitlab_docs: GitLab documentation-specific rules
  • .vale.ini: Pre-configured Vale configuration file

Installation

  1. Download and extract GitLab_Vale_Rules.zip
  2. Copy the contents to your project
  3. Run Vale on your documentation:
    vale --config=GitLab_Vale_Rules/.vale.ini your-file.md

File Statistics

  • gitlab_base: $(ls -1 gitlab_base | wc -l | tr -d ' ') rule files
  • gitlab_docs: $(ls -1 gitlab_docs | wc -l | tr -d ' ') rule files

Usage

Basic Usage

vale --config=GitLab_Vale_Rules/.vale.ini docs/

Custom Configuration

You can customize the .vale.ini file to adjust:

  • Alert levels (error, warning, suggestion)
  • Enabled/disabled rules
  • File type associations

Source

These rules are automatically synced from:


Release Date: $(date +'%Y-%m-%d')