# ![markuplint](https://cdn.rawgit.com/YusukeHirao/markuplint/HEAD/media/logo-v.svg) [![npm version](https://badge.fury.io/js/markuplint.svg)](https://badge.fury.io/js/markuplint) [![Build Status](https://travis-ci.org/markuplint/markuplint.svg?branch=master)](https://travis-ci.org/markuplint/markuplint) [![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=master)](https://coveralls.io/github/markuplint/markuplint?branch=master) A Linter for All Markup Languages (for legacy/modern HTML, Web Components, SVG, MathML, AMP HTML and more). ## Install ``` $ npm install -D markuplint $ yarn add -D markuplint ``` Supported for _Node.js_ `v12.4.0` or later. ## Usage ### CLI ``` $ npx markuplint verifyee.html ``` ``` $ npx markuplint --help Usage $ markuplint $ | markuplint Options --config-file, -c FILE_PATH Ruleset file path. --fix, Fix HTML. --format, -f FORMAT Output format. Support "JSON", "Simple" and "Standard". Default: "Standard". --no-color, Output no color. --problem-only, -p Output only problems, without passeds. --verbose Output with detailed information. --help, -h Show help. --version, -v Show version. Examples $ markuplint verifyee.html --ruleset path/to/.markuplintrc $ cat verifyee.html | markuplint ``` ![Screen shot](media/screenshot01.png) ### API - [Functions](https://markuplint.dev/api-docs#Functions) - [Interface Document](https://api.markuplint.dev) (genereated by [TypeDoc](https://typedoc.org/)) ## Configuration - [Configuration](https://markuplint.dev/configuration) ## Rules - [Rules](https://markuplint.dev/rules) - Customizing your rule **🚧 WIP** ## Thanks This linter is inspired by: - [HTMLHint](http://htmlhint.com/) - [ESLint](https://eslint.org/) - [stylelint](https://stylelint.io/) - [textlint](https://textlint.github.io/)