.png)
If you manage technical documentation, you know Vale. It is the industry standard for prose linting. It is powerful, open-source, and highly customizable.
But "customizable" is a double-edged sword.
To get Vale running effectively in a CI/CD pipeline, you often end up managing a complex web of .vale.ini files, styles/ directories, and vocab.txt lists. You become a "Linter Mechanic" instead of a writer or engineer.
We built EkLine not to replace the need for quality checks, but to remove the maintenance tax associated with them.
Here is a look at the difference between the "Do-It-Yourself" approach (Vale) and the "Batteries-Included" approach (EkLine).
Vale is an incredible engine. It uses Regular Expressions to catch style violations. But out of the box, it does very little. You have to build the car around the engine.
To set up a robust Vale environment, you typically need:
vale.ini configuration file.Typical Vale Config:
StylesPath = styles
MinAlertLevel = suggestion
Packages = Google, Microsoft
[*.md]
BasedOnStyles = Vale, Google
Google.Passive = NO
Microsoft.Contractions = YES
You have to decide every rule. You have to maintain every exception.
When you add Vale to a GitHub Action, it lints the entire file.
If a developer fixes a typo in a 5,000-line legacy file, Vale might flag 50 preexisting style errors.
Result: The developer ignores the check, or you turn it off.
We designed EkLine to be the tool you drop into your workflow when you want results, not a configuration project. It is a Documentation Reviewer that works out of the box.
EkLine comes pre-trained with the best practices from the Google Developer Style Guide and Microsoft Manual of Style. You don't need to create a styles folder. You don't need to write Regex.
You simply add the action, and it starts reviewing.
YAML
# .github/workflows/ekline.yml
- uses: ekline-io/ekline-github-action@v1
with:
ek_token: ${{ secrets.EKLINE_KEY }}
reporter: github-pr-review
filter_mode: added
That’s it. No external config files required.
With Vale, you need a second tool to check for 404s (Broken Links).
EkLine includes Broken Link Validation natively.
It scans your docs for dead URLs and invalid email formats automatically during the review. One tool, one workflow.
This is the feature developers love most. EkLine allows you to scope the review strictly to the lines changed in the PR.
This means you can add EkLine to a massive, messy legacy repo today, and it won't scream about old errors. It will only guard the new code.
Vale is a great engine for those who want to build their own linter.
EkLine is a complete car for those who just want to drive.
If you are tired of maintaining .ini files and want a reviewer that just works, give EkLine a try.