mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
34 lines
457 B
Markdown
34 lines
457 B
Markdown
# Markdown lint tool
|
|
|
|
Tool to check markdown files and flag style issues.
|
|
|
|
## Table of contents <!-- omit in toc -->
|
|
|
|
1. [TL;DR](#tldr)
|
|
1. [Further readings](#further-readings)
|
|
|
|
## TL;DR
|
|
|
|
```sh
|
|
# Install.
|
|
gem install mdl
|
|
|
|
# Check files.
|
|
mdl README.md
|
|
mdl path/to/dir/
|
|
|
|
# Ignore a specific rule.
|
|
mdl -r "~MD013" README.md
|
|
```
|
|
|
|
## Further readings
|
|
|
|
- [GitHub]
|
|
|
|
<!--
|
|
References
|
|
-->
|
|
|
|
<!-- Upstream -->
|
|
[github]: https://github.com/markdownlint/markdownlint
|