README
remark-preset-wooorm
My personal markdown (and prose) style.
Learn more about presets in unified’s docs.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be import
ed instead of require
d.
npm:
npm install remark-cli remark-preset-wooorm
Now add the following to your package.json
:
"scripts": {
"build-md": "remark . -qfo"
"test": "npm run build-md && ..."
},
"remarkConfig": {
"plugins": [
"preset-wooorm"
]
},
From now on, npm test
also checks and formats markdown.
npm test
Checks
Markdown
- Extends
remark-preset-lint-recommended
, and adds a strict code-style (seeindex.js
) - Checks broken local links
- Markdown is compiled with asterisks (
*
) for list-item bullets and emphasis, and fenced code blocks (note: setoutput: true
in your config to benefit from this) - How remark compiles can be configured inline with comments
Table of Contents
headers are kept up to date, with a depth of3
(ifoutput: true
)- GH references, like mentions or issue references, are
linked (if
output: true
)
Natural language
See retext-preset-wooorm
for more info.
- English parsing
- Two spaces between sentences
- Checks “indefinite articles”: “a” or “an”
- Checks quotes and apostrophes (
""
>“”
) - Checks accidental repeated words
- Checks diacritics
- Checks redundant acronyms
- Checks incorrectly placed apostrophes in contractions