https://github.com/jaymzh/markdownlint-ng
https://github.com/jaymzh/markdownlint-ng
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jaymzh/markdownlint-ng
- Owner: jaymzh
- License: mit
- Created: 2019-10-18T03:56:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T07:52:22.000Z (over 6 years ago)
- Last Synced: 2025-09-01T00:08:58.142Z (10 months ago)
- Size: 330 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://waffle.io/mivok/markdownlint)
[](https://travis-ci.org/markdownlint/markdownlint)
[](http://badge.fury.io/rb/mdl)
# Markdown lint tool
A tool to check markdown files and flag style issues.
## Installation
Markdownlint is written in ruby and is distributed as a rubygem. As long as
you have a relatively up to date ruby on your system, markdownlint will be
simple to install and use. You have 2 options to install it:
To install from rubygems, run:
gem install mdl
To install the latest development version from github:
git clone https://github.com/markdownlint/markdownlint
cd markdownlint
rake install
Note that you will need [rake](https://github.com/ruby/rake)
(`gem install rake`) and [bundler](https://github.com/bundler/bundler)
(`gem install bundler`) in order to build from source.
## Usage
To have markdownlint check your markdown files, simply run `mdl` with the
filenames as a parameter:
mdl README.md
Markdownlint can also take a directory, and it will scan all markdown files
within the directory (and nested directories):
mdl docs/
If you don't specify a filename, markdownlint will use stdin:
cat foo.md | mdl
Markdownlint will output a list of issues it finds, and the line number where
the issue is. See [RULES.md](docs/RULES.md) for information on each issue, as
well as how to correct it:
README.md:1: MD013 Line length
README.md:70: MD029 Ordered list item prefix
README.md:71: MD029 Ordered list item prefix
README.md:72: MD029 Ordered list item prefix
README.md:73: MD029 Ordered list item prefix
Markdownlint has many more options you can pass on the command line, run
`mdl --help` to see what they are, or see the documentation on
[configuring markdownlint](docs/configuration.md).
### Styles
Not everyone writes markdown in the same way, and there are multiple flavors
and styles, each of which are valid. While markdownlint's default settings
will result in markdown files that reflect the author's preferred markdown
authoring preferences, your project may have different guidelines.
It's not markdownlint's intention to dictate any one specific style, and in
order to support these differing styles and/or preferences, markdownlint
supports what are called 'style files'. A style file is a file describing
which rules markdownlint should enable, and also what settings to apply to
individual rules. For example, rule [MD013](docs/RULES.md#md013---line-length)
checks for long lines, and by default will report an issue for any line longer
than 80 characters. If your project has a different maximum line length limit,
or if you don't want to enforce a line limit at all, then this can be
configured in a style file.
For more information on creating style files, see the
[creating styles](docs/creating_styles.md) document.
## Related projects
- [markdownlint](https://github.com/DavidAnson/markdownlint) and
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) for
Node.js
## Contributing
1. Fork it ( )
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create new Pull Request