{"id":17001995,"url":"https://github.com/sagiegurari/grunt-markdownlint","last_synced_at":"2025-04-12T06:31:46.007Z","repository":{"id":38325326,"uuid":"60842153","full_name":"sagiegurari/grunt-markdownlint","owner":"sagiegurari","description":"A grunt task for markdown style checker and lint tool.","archived":false,"fork":false,"pushed_at":"2023-01-19T17:38:02.000Z","size":242,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T16:08:41.978Z","etag":null,"topics":["grunt","gruntplugin","lint","markdown","markdownlint","nodejs","validate"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sagiegurari.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-10T11:09:39.000Z","updated_at":"2024-05-25T07:07:48.000Z","dependencies_parsed_at":"2023-01-31T07:00:32.953Z","dependency_job_id":null,"html_url":"https://github.com/sagiegurari/grunt-markdownlint","commit_stats":null,"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sagiegurari%2Fgrunt-markdownlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sagiegurari%2Fgrunt-markdownlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sagiegurari%2Fgrunt-markdownlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sagiegurari%2Fgrunt-markdownlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sagiegurari","download_url":"https://codeload.github.com/sagiegurari/grunt-markdownlint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248529717,"owners_count":21119567,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grunt","gruntplugin","lint","markdown","markdownlint","nodejs","validate"],"created_at":"2024-10-14T04:26:48.906Z","updated_at":"2025-04-12T06:31:45.555Z","avatar_url":"https://github.com/sagiegurari.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-markdownlint\n\n[![NPM Version](http://img.shields.io/npm/v/grunt-markdownlint.svg?style=flat)](https://www.npmjs.org/package/grunt-markdownlint) [![CI](https://github.com/sagiegurari/grunt-markdownlint/workflows/CI/badge.svg?branch=master)](https://github.com/sagiegurari/grunt-markdownlint/actions) [![Coverage Status](https://coveralls.io/repos/sagiegurari/grunt-markdownlint/badge.svg)](https://coveralls.io/r/sagiegurari/grunt-markdownlint) [![Known Vulnerabilities](https://snyk.io/test/github/sagiegurari/grunt-markdownlint/badge.svg)](https://snyk.io/test/github/sagiegurari/grunt-markdownlint) [![Inline docs](http://inch-ci.org/github/sagiegurari/grunt-markdownlint.svg?branch=master)](http://inch-ci.org/github/sagiegurari/grunt-markdownlint) [![License](https://img.shields.io/npm/l/grunt-markdownlint.svg?style=flat)](https://github.com/sagiegurari/grunt-markdownlint/blob/master/LICENSE) [![Total Downloads](https://img.shields.io/npm/dt/grunt-markdownlint.svg?style=flat)](https://www.npmjs.org/package/grunt-markdownlint)\n\n\u003e A grunt task for markdown style checker and lint tool.\n\n* [Overview](#overview)\n* [Usage](#usage)\n* [Installation](#installation)\n* [API Documentation](docs/api.md)\n* [Contributing](.github/CONTRIBUTING.md)\n* [Release History](#history)\n* [License](#license)\n\n\u003ca name=\"overview\"\u003e\u003c/a\u003e\n## Overview\nThe markdownlint grunt plugin enables to run rule based linting on your project markdown files.\n\nSee [markdownlint](https://github.com/DavidAnson/markdownlint) for more information.\n\nFor linting rules, please see [Rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md) document.\n\n\u003ca name=\"usage\"\u003e\u003c/a\u003e\n## Usage\nIn order to use the markdownlint plugin, please use following example:\n\n```js\n//to use via grunt, first load the task\nrequire('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks\n//or load it manually\ngrunt.loadNpmTasks('grunt-markdownlint');\n\ngrunt.initConfig({\n  markdownlint: {\n    example1: {\n      options: {\n        config: { //configure the linting rules\n          'default': true,\n          'line-length': false,\n          'blanks-around-headers': false,\n          'no-duplicate-header': false,\n          'no-inline-html': false\n        }\n      },\n      src: [\n        'README.md',\n        '.github/*.md'\n      ]\n    },\n    example2: {\n      options: {\n        config: grunt.file.readJSON(rulesFile) //read linting rules from file\n      },\n      src: [\n        'README.md',\n        '.github/*.md'\n      ]\n    }\n  }\n});\n\ngrunt.registerTask('default', ['markdownlint:example1']);\n```\n\nThe different options are defined in the markdownlint [api](https://github.com/DavidAnson/markdownlint#api) documentation.\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## Installation\nIn order to use this library, just run the following npm install command:\n\n```sh\nnpm install --save-dev grunt-markdownlint\n```\n\n## API Documentation\nSee full docs at: [API Docs](docs/api.md)\n\n## Contributing\nSee [contributing guide](.github/CONTRIBUTING.md)\n\n\u003ca name=\"history\"\u003e\u003c/a\u003e\n## Release History\n\n| Date        | Version | Description |\n| ----------- | ------- | ----------- |\n| 2022-12-28  | v3.1.6  | Upgrade markdownlint version |\n| 2022-08-06  | v3.1.5  | Upgrade markdownlint version |\n| 2022-01-04  | v3.1.4  | Upgrade markdownlint version |\n| 2021-08-24  | v3.1.3  | Upgrade markdownlint version |\n| 2021-02-08  | v3.1.2  | Upgrade markdownlint version |\n| 2020-11-26  | v3.1.1  | Upgrade markdownlint version |\n| 2020-09-22  | v3.1.0  | Upgrade markdownlint version |\n| 2020-05-11  | v3.0.0  | Migrate to github actions and upgrade minimal node version |\n| 2020-04-13  | v2.10.0 | Upgrade markdownlint version |\n| 2018-06-07  | v2.0.0  | Upgrade markdownlint and minimal node version |\n| 2018-05-29  | v1.1.6  | Upgrade markdownlint version |\n| 2016-11-04  | v1.0.11 | Support new markdownlint 0.3.0 options |\n| 2016-07-01  | v0.1.0  | Updated task config to use options |\n| 2016-06-14  | v0.0.5  | Initial release |\n\n\u003ca name=\"license\"\u003e\u003c/a\u003e\n## License\nDeveloped by Sagie Gur-Ari and licensed under the Apache 2 open source license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsagiegurari%2Fgrunt-markdownlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsagiegurari%2Fgrunt-markdownlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsagiegurari%2Fgrunt-markdownlint/lists"}