Personal markdown (and prose) style
MIT License
My personal markdown (and prose) style.
This is a preset for remark to check markdown. It’s used on all the readmes I work on.
Feel free to use this. But you can also create your own personal style preset.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-preset-wooorm
In Deno with esm.sh
:
import remarkPresetWooorm from 'https://esm.sh/remark-preset-wooorm@10'
In browsers with esm.sh
:
<script type="module">
import remarkPresetWooorm from 'https://esm.sh/remark-preset-wooorm@10?bundle'
</script>
import {remark} from 'remark'
import remarkPresetWooorm from 'remark-preset-wooorm'
import {reporter} from 'vfile-reporter'
const file = await remark()
.use(remarkPresetWooorm)
.process('This *and* _and_ that.')
console.error(reporter(file))
Yields:
1:7-1:16 warning Unexpected repeated `and`, remove one occurrence and retext-repeated-words
1:12-1:17 warning Unexpected emphasis marker `_`, expected `*` emphasis-marker remark-lint
1:23 warning Unexpected missing final newline character, expected line feed (`\n`) at end of file final-newline remark-lint
⚠ 3 warnings
This package exports no identifiers.
The default export is remarkPresetWooorm
.
It exports no TypeScript types.
remarkPresetWooorm
Preset to support my personal markdown style (Preset
).
remark-preset-lint-recommended
,index.js
)*
) for list-item bullets andoutput: true
in your config toContents
headers are kept up to date, with a depth of 3
(ifoutput: true
)output: true
)See retext-preset-wooorm
for more info.
""
> “”
)This projects is compatible with maintained versions of Node.js.
When we cut a new major release,
we drop support for unmaintained versions of Node.
This means we try to keep the current release line,
remark-preset-wooorm@10
,
compatible with Node.js 16.
retext-preset-wooorm
Yes please! See How to Contribute to Open Source.