\n
![\"Logo](\"https://raw.githubusercontent.com/htmlhint/HTMLHint/main/website/src/assets/img/htmlhint.png\")
\n \n HTMLHint\n
\n
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/htmlhint\")
\n \n \n
![\"npm](\"https://img.shields.io/npm/dm/htmlhint.svg\")
\n \n \n ![\"MIT](\"https://img.shields.io/github/license/htmlhint/HTMLHint\")
\nĀ How To Use ā¢ Contributing ā¢ Website\n
\n\n## Table of Contents\n\n- **[Installation and Usage](#-installation-and-usage)**\n - **[Local Installation and Usage](#local-installation-and-usage)**\n - **[Global Installation and Usage](#global-installation-and-usage)**\n- **[Example output](#-example-output)**\n- **[Configuration](#-configuration)**\n- **[Docs](#-docs)**\n\n## š Installation and Usage\n\nThere are two ways to install HTMLHint: globally and locally.\n\n### Local Installation and Usage\n\nIn case you want to include HTMLHint as part of your project, you can install it locally using npm:\n\n```bash\nnpm install htmlhint --save-dev\n```\n\nAfter that, You can run HTMLHint on any file or directory like this:\n\n```bash\n./node_modules/.bin/htmlhint www/index.html\n./node_modules/.bin/htmlhint www/**/*.html\n```\n\nOr, you can use HTMLHint linter programmatically, like this:\n\n```js\nimport { HTMLHint } from 'htmlhint'\nconst htmlVerificationHints = HTMLHint.verify(localHtmlContent)\nconsole.log('htmlVerificationHints', htmlVerificationHints) // this logs a list of `Hint`s which contain information on all linting errors\n```\n\n### Global Installation and Usage\n\nIf you want to make HTMLHint available to tools that run across all of your projects, you can install HTMLHint globally using npm:\n\n```bash\nnpm install htmlhint -g\n```\n\nAfter that, you can run HTMLHint on any file like this:\n\n```bash\nhtmlhint www/index.html\nhtmlhint www/**/*.html\n```\n\nYou can even launch HTMLHint to analyze an URL:\n\n```bash\nhtmlhint https://htmlhint.com/\n```\n\n## š Example output\n\n## š§ Configuration\n\nSearch `.htmlhintrc` file in current directory and all parent directories:\n\n```bash\nhtmlhint\nhtmlhint test.html\n```\n\nCustom config file:\n\n```bash\nhtmlhint --config htmlhint.conf test.html\n```\n\nCustom rules:\n\n```bash\nhtmlhint --rules tag-pair,id-class-value=underline index.html\n```\n\nInline rules in `test.html`:\n\n```html\n\n\n \n ...\n \n\n```\n\n## š Docs\n\n1. [How to use](https://htmlhint.com/getting-started/)\n2. [All Rules](https://htmlhint.com/rules/)\n3. [Changelog](https://htmlhint.com/changelog/)\n4. [How to Develop](/.github/CONTRIBUTING.md)\n\n## Ā© License\n\n[MIT License](./LICENSE.md)\n\n## šŖš» Contributors\n\nThis project exists thanks to all these people. [Contribute](/.github/CONTRIBUTING.md).\n![\"HTMLHint](\"https://opencollective.com/htmlhint/contributors.svg?width=890\")
\n\n## š
Backers\n\nThank you to all our backers! [Become a backer](https://opencollective.com/htmlhint#backer).\n\n![\"Backers\"](\"https://opencollective.com/htmlhint/backers.svg?width=890\")
\n\n## š Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/htmlhint#sponsor).\n\n![\"Sponsor\"](\"https://opencollective.com/htmlhint/sponsor/0/avatar.svg\"){kind=avatar}
\n","readmeFilename":"README.md","users":{"j3lte":true,"finico":true,"skerit":true,"taraman":true,"vivekrp":true,"tdmalone":true,"rubiadias":true,"alexdevero":true,"flumpus-dev":true}}