vale
markdownlint
Our great sponsors
vale | markdownlint | |
---|---|---|
46 | 7 | |
4,178 | 4,446 | |
3.1% | - | |
9.3 | 9.6 | |
7 days ago | 6 days ago | |
Go | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
vale
- Software Technical Writing: A Guidebook [pdf]
- Grammarly editor writing service are malfunctioning
- Vale.sh – A Linter for Prose
- Ask HN: Best tool to proof-read technical documentation?
- Val, a high-level systems programming language
-
Common Bugs in Writing
Vale is an OSS tool that you can use as a "prose linter" with many of these rules. You can also write your own rules. Together with a spellchecker its a good replacement for proprietary tools like grammarly.
- https://github.com/errata-ai/vale
-
Just Simply – Stop saying how simple things are in our docs
> Write in US English with US grammar. (Tested in British.yml.)
heh, that was funny but it turns out the file is a list of British words checked using Vale, which I just learned existed: https://github.com/errata-ai/vale#readme (MIT)
Also, another TIL is that the "e" version of gray is British https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale... I had previously erroneously assumed they were just one of those quirks of English (which, I guess is still true but it is less random than I thought)
-
Tools that enforce/promote corporate standards?
Off the top of my head, Vale and Acrolinx.
-
Over 60% of Writers Already Use AI in Their Writing Workflow
I have recently thought of feeding the suggestions from Vale (https://vale.sh/) into an LLM along with your writing. Currently I just simply ask an LLM to take what I wrote and put it into a more "active voice". I then manually edit my writing to make it more "active" if I choose -- I do not just publish LLM generated content unaltered.
Note: I did not ask an LLM for this comment.
-
What terminal apps are you using?
vale to spell check and enforce writing style on my articles
markdownlint
-
Blogging in Djot Instead of Markdown
Some of Djot's features can be achieved by using markdownlint though: https://github.com/DavidAnson/markdownlint
-
Recommended Linters
markdownlint - A Node.js style checker and lint tool for Markdown/CommonMark files.
-
Regal v0.14.0 released
Improvements - The prefer-some-in-iteration rule will by default no longer flag iteration where a sub-attribute is used, like input[_].item - The use-in-operator rule has been extended to include more types of items, leading to better discovery of locations where in should be used - Remove replace directive in go.mod that made hard to integrate Regal as a library - The project now uses markdownlint to ensure consistent formatting of its documentation - The Go API now allows reading custom rules from an fs.FS filesystem
-
Project idea: port markdownlint to Rust
People are always looking for simple projects to learn Rust with, so here's one for anyone who's currently looking. Port markdownlint to Rust. Markdownlint is ~3.3k lines of JavaScript (including the lint implementation themselves!), so I reckon it's pretty doable.
-
VS Code - Catch errors in your markdown files
The markdownlint VS Code extension is powered by the Node library of the same name. Its usage is quite similar to ESLint. It has a set of rules that can be configured, errors are highlighted, and you can automatically fix simple errors.
-
Markdown Linting
Markdown Lint
-
10 Best Visual Studio Code Extensions for Flutter Development
There are no compilers in the Flutter project that guarantee to find issues in README.md or CHANGELOG.md files. To remedy this, the Markdownlint plugin provides a set of guidelines to encourage Markdown file standards and uniformity. You can use this extension to check for problems locally and verify the content before publishing it live. Browse the user manual to learn more about rules.
What are some alternatives?
proselint - A linter for prose.
remark-lint - plugins to check (lint) markdown code style
lsp-grammarly - lsp-mode ❤️ grammarly
write-good - Naive linter for English prose
nvim-lspconfig - Quickstart configs for Nvim LSP
flutter-examples - This repository contains the Syncfusion Flutter UI widgets examples and the guide to use them.
dart_style - An opinionated formatter/linter for Dart code
markdownlint - Repository for the markdownlint-mdl-action Github Action
docs - Linode guides and tutorials.
Visual Studio Code - Visual Studio Code