GitHub markdown and prose style.
Learn more about presets in unified's docs.
NOTE: Feel free to open an issue if something isn't working right.
Installation
npm:
npm install remark-cli remark-preset-github --save
Now add the following to your package.json
:
"scripts": {
"build-md": "remark ."
"test": "npm run build-md && ..."
},
"remarkConfig": {
"plugins": [
"preset-github"
]
},
From now on, npm test
also checks markdown.
npm test
Checks
Markdown
- Adds a license section
- Adds a contributors section
- Extends
remark-preset-lint-recommended
,
and adds a strict code-style (see index.js
) - Markdown is compiled with asterisk list-item bullets (
*
),
and fenced code blocks (note: set output: 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 of 3
(if output: true
)- GH references, like mentions or issue references, are
linked (if
output: true
)
Natural Language
See retext-preset-github
for more info.
Contributors
License
MIT © Titus Wormer