1 Star 1 Fork 0

codeveryday/rook

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
.markdownlint-cli2.cjs 1.83 KB
一键复制 编辑 原始数据 按行查看 历史
module.exports = {
"config": {
"default": false, // no default rules enabled
"extends": null, // no default rules enabled
"list-indent": true, // all list items must be indented at the same level
"ul-indent": {
"indent": 4, // mkdocs requires 4 spaces for tabs
},
"no-hard-tabs": {
"spaces_per_tab": 4, // mkdocs requires 4 spaces for tabs
},
"ol-prefix": {
// require fully-numbered lists. this rule helps ensure that code blocks in between ordered
// list items (which require surrounding spaces) don't break lists
"style": "ordered",
},
"blanks-around-lists": true, // mkdocs requires blank lines around lists
"blanks-around-fences": { // mkdocs requires blank lines around code blocks (fences)
"list_items": true, /// ... including in lists
},
"code-block-style": {
// do not allow implicit code blocks. ensure code blocks have fences so we know explicitly
// what will be rendered
"style": "fenced",
},
"fenced-code-language": {
// enforce code blocks must have language specified
// this helps ensure rendering is as intended, and it helps doc-wide searches for code blocks
language_only: true,
},
"no-duplicate-heading": true, // do not allow duplicate headings
"link-fragments": true, // validate links to headings within a doc
"single-trailing-newline": true, // require single trailing newline in docs
"no-multiple-blanks": {
// allow max 2 blank lines in markdown docs
"maximum": 2,
},
// custom rules for Rook!
"mkdocs-admonitions": true, // checking mkdocs admonitions format
"strict-tab-spacing": true, // enforce strict 4-space tabs for mkdocs
},
"customRules": [
"./tests/scripts/markdownlint-admonitions.js",
"./tests/scripts/markdownlint-tab-spacing.js",
],
};
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/codeveryday/rook.git
git@gitee.com:codeveryday/rook.git
codeveryday
rook
rook
master

搜索帮助