markdownlint
vale
Our great sponsors
markdownlint | vale | |
---|---|---|
2 | 46 | |
1,700 | 4,166 | |
1.1% | 2.9% | |
6.4 | 9.3 | |
3 months ago | 8 days ago | |
Ruby | Go | |
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.
markdownlint
-
Markdown Linting
markdownlint is a node.js markdown linter that is easy to install and easy to customize. It is based on an earlier Ruby tool, also called markdownlint. Both are great, but the Node.js tool is easy to install and easy to customize.
-
Docker Build `--replace`
An example of where this can be convenient is when you want to use an external program or project that uses a language that isn't supported by your project. For example, the build process for this blog's content uses Node.js, but consider the case where I wanted to use a Markdown linter defined in Ruby, such as Markdownlint. One option is to add a Ruby installation directly to the definition of the build environment, but this has a few disadvantages:
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.
-
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
What are some alternatives?
proselint - A linter for prose.
vale-styles - Checks for Vale based on popular style guides
lsp-grammarly - lsp-mode ❤️ grammarly
alex - Catch insensitive, inconsiderate writing
nvim-lspconfig - Quickstart configs for Nvim LSP
write-good - Naive linter for English prose
docs - Linode guides and tutorials.
markdownlint - Repository for the markdownlint-mdl-action Github Action
markdownlint - A Node.js style checker and lint tool for Markdown/CommonMark files.
remark-lint - plugins to check (lint) markdown code style