GitLab Vale Rules 1.0.2
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
- Download and extract
GitLab_Vale_Rules.zip - Copy the contents to your project
- 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:
- https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.vale/gitlab_base
- https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.vale/gitlab_docs
Release Date: $(date +'%Y-%m-%d')
Source Commit: a21ba3e