remark-preset-github

GitHub markdown and prose style

MIT 30 个版本
github preset remark
主页
仓库
提交 Issue
安装
npm install remark-preset-github
yarn add remark-preset-github
pnpm add remark-preset-github
bun add remark-preset-github
README

remark-preset-github

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

Name website
Nick Baugh https://niftylettuce.com

License

MIT © Titus Wormer

版本列表
4.0.4 2022-06-06
4.0.3 2022-06-04
4.0.2 2022-06-01
4.0.1 2020-11-24
4.0.0 2020-11-24
3.0.4 2020-10-26
3.0.3 2020-10-18
3.0.2 2020-10-18
3.0.1 2020-10-17
3.0.0 2020-07-28
2.0.2 2020-07-03
2.0.1 2020-07-03
2.0.0 2020-06-20
1.0.1 2020-05-14
1.0.0 2020-04-01
0.0.16 2019-08-30
0.0.15 2019-08-30
0.0.14 2019-06-22
0.0.13 2018-10-31
0.0.12 2018-10-31
0.0.11 2018-10-31
0.0.10 2018-10-31
0.0.9 2018-10-02
0.0.8 2018-01-23
0.0.7 2017-10-01
0.0.6 2017-09-05
0.0.5 2017-09-01
0.0.3 2017-09-01
0.0.2 2017-08-30
0.0.1 2017-08-21