{"id":19175300,"url":"https://github.com/andrepolischuk/docslint","last_synced_at":"2025-05-07T19:09:42.727Z","repository":{"id":57214271,"uuid":"113445269","full_name":"andrepolischuk/docslint","owner":"andrepolischuk","description":"Lint and fix docs simpler","archived":false,"fork":false,"pushed_at":"2017-12-13T11:53:47.000Z","size":186,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-12T04:23:26.365Z","etag":null,"topics":["docs","fix","lint","text","textlint"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrepolischuk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-07T11:55:52.000Z","updated_at":"2022-07-17T12:19:40.000Z","dependencies_parsed_at":"2022-08-24T21:41:48.767Z","dependency_job_id":null,"html_url":"https://github.com/andrepolischuk/docslint","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrepolischuk%2Fdocslint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrepolischuk%2Fdocslint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrepolischuk%2Fdocslint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrepolischuk%2Fdocslint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrepolischuk","download_url":"https://codeload.github.com/andrepolischuk/docslint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223813404,"owners_count":17207267,"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":["docs","fix","lint","text","textlint"],"created_at":"2024-11-09T10:22:31.831Z","updated_at":"2024-11-09T10:22:32.367Z","avatar_url":"https://github.com/andrepolischuk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docslint [![Build Status][travis-image]][travis-url]\n\n\u003e Lint and fix docs simpler\n\nUnder the hood `docslint` uses [`textlint`][textlint] with predefined rule set. It’s a simple zero-config tool that works out of the box like [`standard`][standard] and [`xo`][xo].\n\n![](screenshot.png)\n\n## Install\n\n```sh\nnpm install --global docslint\n```\n\n## Usage\n\n```sh\ndocslint --help\n\n  Lint and fix docs simpler\n\n  Usage\n    docslint [file|glob ...]\n\n  Options\n    --fix      Automatically fix issues\n    --disable  Rules to disable, can be set multiple times\n\n  Examples\n    docslint\n    docslint readme.md\n    docslint *.md !readme.md\n    docslint --fix\n    docslint --disable terminology\n```\n\n## Rules\n\n[Base configuration](https://github.com/andrepolischuk/docslint/blob/master/lib/createConfig.js#L20-L36) contains following rules:\n\n* [`common-misspellings`](https://github.com/io-monad/textlint-rule-common-misspellings) — check common misspellings\n* [`apostrophe`](https://github.com/sapegin/textlint-rule-apostrophe) — check and fix correct apostrophe usage\n* [`diacritics`](https://github.com/sapegin/textlint-rule-diacritics) — check and fix the usage of diacritics\n* [`stop-words`](https://github.com/sapegin/textlint-rule-stop-words) — find filler words, buzzwords and clichés\n* [`terminology`](https://github.com/sapegin/textlint-rule-terminology) — check and fix correct terms spelling\n* [`no-dead-link`](https://github.com/nodaguti/textlint-rule-no-dead-link) — check if all links are available or not\n* [`no-start-duplicated-conjunction`](https://github.com/azu/textlint-rule-no-start-duplicated-conjunction) — check no start with duplicated conjunction\n* [`real-symbols`](https://github.com/andrepolischuk/textlint-rule-real-symbols) — check and fix symbols\n* [`write-good`](https://github.com/nodaguti/textlint-rule-write-good) — naive linter for English prose for developers\n* [`en-capitalization`](https://github.com/textlint-rule/textlint-rule-en-capitalization) — check and fix capitalization\n\nYou can disable any rule by running `docslint` with `--disable \u003crule\u003e` flag.\n\n## License\n\nMIT\n\n[travis-url]: https://travis-ci.org/andrepolischuk/docslint\n[travis-image]: https://travis-ci.org/andrepolischuk/docslint.svg?branch=master\n\n[textlint]: https://github.com/textlint/textlint\n[standard]: https://github.com/standard/standard\n[xo]: https://github.com/sindresorhus/xo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrepolischuk%2Fdocslint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrepolischuk%2Fdocslint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrepolischuk%2Fdocslint/lists"}