# @blackglory/markdown-lint

> 自以为是的 Markdown lint, 基于 [remark-lint], 为写出更具有可维护性的 Markdown 文档而设计. 仍在完善中.

Latest version **0.2.2** (published 2021-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blackglory/markdown-lint
pnpm add @blackglory/markdown-lint
yarn add @blackglory/markdown-lint
bun add @blackglory/markdown-lint
```

Provides the command `markdown-lint`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2021-02-04 |
| First published | 2020-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 61 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | BlackGlory |
| Maintainers | black_glory |

## Links

- npm: https://www.npmjs.com/package/@blackglory/markdown-lint
- Repository: https://github.com/BlackGlory/markdown-lint
- Homepage: https://github.com/BlackGlory/markdown-lint#readme
- Issues: https://github.com/BlackGlory/markdown-lint/issues
- npm.io page: https://npm.io/package/@blackglory/markdown-lint

## Dependencies (61)

- [vfile](https://npm.io/package/vfile.md) ^4.2.0
- [remark](https://npm.io/package/remark.md) ^12.0.1
- [vfile-reporter](https://npm.io/package/vfile-reporter.md) ^6.0.1
- [iterable-operator](https://npm.io/package/iterable-operator.md) ^0.12.1
- [remark-lint-no-html](https://npm.io/package/remark-lint-no-html.md) ^2.0.1
- [remark-lint-no-tabs](https://npm.io/package/remark-lint-no-tabs.md) ^2.0.1
- [remark-lint-rule-style](https://npm.io/package/remark-lint-rule-style.md) ^2.0.1
- [remark-lint-table-pipes](https://npm.io/package/remark-lint-table-pipes.md) ^2.0.1
- [remark-lint-no-empty-url](https://npm.io/package/remark-lint-no-empty-url.md) ^2.0.1
- [remark-lint-final-newline](https://npm.io/package/remark-lint-final-newline.md) ^1.0.5
- [remark-lint-heading-style](https://npm.io/package/remark-lint-heading-style.md) ^2.0.1
- [remark-lint-strong-marker](https://npm.io/package/remark-lint-strong-marker.md) ^2.0.1
- [remark-lint-file-extension](https://npm.io/package/remark-lint-file-extension.md) ^1.0.5
- [remark-lint-emphasis-marker](https://npm.io/package/remark-lint-emphasis-marker.md) ^2.0.1
- [remark-lint-linebreak-style](https://npm.io/package/remark-lint-linebreak-style.md) ^2.0.1
- [remark-lint-no-literal-urls](https://npm.io/package/remark-lint-no-literal-urls.md) ^2.0.1
- [remark-lint-code-block-style](https://npm.io/package/remark-lint-code-block-style.md) ^2.0.1
- [remark-lint-fenced-code-flag](https://npm.io/package/remark-lint-fenced-code-flag.md) ^2.0.1
- [remark-lint-final-definition](https://npm.io/package/remark-lint-final-definition.md) ^2.1.0
- [remark-lint-link-title-style](https://npm.io/package/remark-lint-link-title-style.md) ^2.0.1
- [remark-lint-list-item-indent](https://npm.io/package/remark-lint-list-item-indent.md) ^2.0.1
- [remark-lint-hard-break-spaces](https://npm.io/package/remark-lint-hard-break-spaces.md) ^2.0.1
- [remark-lint-heading-increment](https://npm.io/package/remark-lint-heading-increment.md) ^2.0.1
- [remark-lint-list-item-spacing](https://npm.io/package/remark-lint-list-item-spacing.md) ^2.0.1
- [remark-lint-match-punctuation](https://npm.io/package/remark-lint-match-punctuation.md) ^0.2.0
- [remark-lint-no-empty-sections](https://npm.io/package/remark-lint-no-empty-sections.md) ^4.0.0
- [remark-lint-no-heading-indent](https://npm.io/package/remark-lint-no-heading-indent.md) ^2.0.1
- [remark-lint-no-inline-padding](https://npm.io/package/remark-lint-no-inline-padding.md) ^2.0.1
- [remark-lint-definition-spacing](https://npm.io/package/remark-lint-definition-spacing.md) ^2.0.1
- [remark-lint-fenced-code-marker](https://npm.io/package/remark-lint-fenced-code-marker.md) ^2.0.1
- [remark-lint-spaces-around-word](https://npm.io/package/remark-lint-spaces-around-word.md) ^0.1.1
- [remark-lint-table-cell-padding](https://npm.io/package/remark-lint-table-cell-padding.md) ^2.0.1
- [remark-lint-first-heading-level](https://npm.io/package/remark-lint-first-heading-level.md) ^2.0.1
- [remark-lint-no-table-indentation](https://npm.io/package/remark-lint-no-table-indentation.md) ^2.0.1
- [remark-lint-spaces-around-number](https://npm.io/package/remark-lint-spaces-around-number.md) ^0.1.1
- [remark-lint-table-pipe-alignment](https://npm.io/package/remark-lint-table-pipe-alignment.md) ^2.0.1
- [remark-lint-no-repeat-punctuation](https://npm.io/package/remark-lint-no-repeat-punctuation.md) ^0.1.3
- [remark-lint-no-unused-definitions](https://npm.io/package/remark-lint-no-unused-definitions.md) ^2.0.1
- [remark-lint-blockquote-indentation](https://npm.io/package/remark-lint-blockquote-indentation.md) ^2.0.1
- [remark-lint-no-emphasis-as-heading](https://npm.io/package/remark-lint-no-emphasis-as-heading.md) ^2.0.1
- [remark-lint-no-heading-punctuation](https://npm.io/package/remark-lint-no-heading-punctuation.md) ^2.0.1
- [remark-lint-no-missing-blank-lines](https://npm.io/package/remark-lint-no-missing-blank-lines.md) ^2.0.1
- [remark-lint-checkbox-content-indent](https://npm.io/package/remark-lint-checkbox-content-indent.md) ^2.0.1
- [remark-lint-list-item-bullet-indent](https://npm.io/package/remark-lint-list-item-bullet-indent.md) ^2.0.1
- [remark-lint-no-undefined-references](https://npm.io/package/remark-lint-no-undefined-references.md) ^2.0.1
- [remark-lint-checkbox-character-style](https://npm.io/package/remark-lint-checkbox-character-style.md) ^2.0.1
- [remark-lint-list-item-content-indent](https://npm.io/package/remark-lint-list-item-content-indent.md) ^2.0.1
- [remark-lint-no-duplicate-definitions](https://npm.io/package/remark-lint-no-duplicate-definitions.md) ^2.0.1
- [remark-lint-no-duplicate-defined-urls](https://npm.io/package/remark-lint-no-duplicate-defined-urls.md) ^1.0.1
- [remark-lint-no-heading-content-indent](https://npm.io/package/remark-lint-no-heading-content-indent.md) ^2.0.1
- [remark-lint-no-heading-like-paragraph](https://npm.io/package/remark-lint-no-heading-like-paragraph.md) ^2.0.1
- [remark-lint-ordered-list-marker-style](https://npm.io/package/remark-lint-ordered-list-marker-style.md) ^2.0.1
- [remark-lint-ordered-list-marker-value](https://npm.io/package/remark-lint-ordered-list-marker-value.md) ^2.0.1
- [remark-lint-no-consecutive-blank-lines](https://npm.io/package/remark-lint-no-consecutive-blank-lines.md) ^2.0.1
- [remark-lint-no-paragraph-content-indent](https://npm.io/package/remark-lint-no-paragraph-content-indent.md) ^2.0.1
- [remark-lint-unordered-list-marker-style](https://npm.io/package/remark-lint-unordered-list-marker-style.md) ^2.0.1
- [remark-lint-no-blockquote-without-marker](https://npm.io/package/remark-lint-no-blockquote-without-marker.md) ^3.0.1
- [remark-lint-no-auto-link-without-protocol](https://npm.io/package/remark-lint-no-auto-link-without-protocol.md) ^2.0.1
- [remark-lint-no-multiple-toplevel-headings](https://npm.io/package/remark-lint-no-multiple-toplevel-headings.md) ^2.0.1
- [remark-lint-no-chinese-punctuation-in-number](https://npm.io/package/remark-lint-no-chinese-punctuation-in-number.md) ^0.1.1
- [remark-lint-no-duplicate-headings-in-section](https://npm.io/package/remark-lint-no-duplicate-headings-in-section.md) ^2.0.2

## Recent versions

- 0.2.2 (latest) — 2021-02-04
- 0.2.1 — 2020-08-16
- 0.2.0 — 2020-08-16
- 0.1.0 — 2020-08-15

## README

# markdown-lint

自以为是的 Markdown lint, 基于 [remark-lint], 为写出更具有可维护性的 Markdown 文档而设计.
仍在完善中.

使用的规则数量很多, 因此在初次使用时很可能遇到大量的格式错误, 用户需要在不断修改文章的过程中掌握这套规范.

## 安装

### 从 npm 安装

```sh
npm install -g @blackglory/markdown-lint
# 或
yarn global add @blackglory/markdown-lint
```

### 从源代码安装

```sh
git clone git@github.com:BlackGlory/markdown-lint.git
cd markdown-lint
yarn install
yarn build
yarn global add "file:$(pwd)"
```

## 使用

```sh
markdown-lint README.md
```

[remark-lint]: https://github.com/remarkjs/remark-lint

---
_Source: https://npm.io/package/@blackglory/markdown-lint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._