2 Star 6 Fork 1

小为 / lint-md

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
MIT

lint-md

专注于中文 markdown 文件的编写格式校验。项目使用 Monorepo 的方式管理,使用 yarn 进行管理多项目。

模块

  • ast-plugin:Ast 插件机制;
  • lint-md:lint-md 核心 node 模块;
  • lint-md-cli:lint-md 的 CLI 工具,便于使用和 ci 集成;

开发指南

  • clone
git clone git@github.com:hustcc/lint-md.git
cd lint-md
  • install
# 务必使用 yarn,使用 yarn 进行 mono repo 的管理。
yarn install
  • test
cd ./packages/lint-md

yarn run test
  • build
yarn run build

其他

  • 项目没有 eslint 相关工具,请务必自行保证代码分支一致;
  • rule 规则的 pr,请先提 issue 讨论,防止无用劳动;
  • 请保证单测覆盖至少 99%;
MIT License Copyright (c) 2019 hustcc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

:books: 检查中文 markdown 编写格式规范的命令行工具,基于 AST,方便集成 ci,写博客 / 文档必备。 expand collapse
JavaScript and 2 more languages
MIT
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
JavaScript
1
https://gitee.com/hustcc/lint-md.git
git@gitee.com:hustcc/lint-md.git
hustcc
lint-md
lint-md
master

Search