{"id":13532065,"url":"https://github.com/avto-dev/markdown-lint","last_synced_at":"2025-04-09T14:09:15.881Z","repository":{"id":44575971,"uuid":"234590454","full_name":"avto-dev/markdown-lint","owner":"avto-dev","description":"Linter for markdown (with presets)","archived":false,"fork":false,"pushed_at":"2023-10-03T07:22:09.000Z","size":64,"stargazers_count":78,"open_issues_count":0,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-15T19:34:29.750Z","etag":null,"topics":["docker","linter","markdown"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/repository/docker/avtodev/markdown-lint/tags","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/avto-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-01-17T16:34:36.000Z","updated_at":"2024-06-24T13:12:44.000Z","dependencies_parsed_at":"2024-01-11T00:03:59.437Z","dependency_job_id":"a881ba2b-0414-4100-9602-a3b8f163b83e","html_url":"https://github.com/avto-dev/markdown-lint","commit_stats":{"total_commits":43,"total_committers":8,"mean_commits":5.375,"dds":"0.34883720930232553","last_synced_commit":"4346d2ea1dab0f14b685bffe058254d0c5abd68a"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avto-dev%2Fmarkdown-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avto-dev%2Fmarkdown-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avto-dev%2Fmarkdown-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avto-dev%2Fmarkdown-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avto-dev","download_url":"https://codeload.github.com/avto-dev/markdown-lint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054196,"owners_count":21039952,"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":["docker","linter","markdown"],"created_at":"2024-08-01T07:01:07.929Z","updated_at":"2025-04-09T14:09:15.861Z","avatar_url":"https://github.com/avto-dev.png","language":"JavaScript","funding_links":[],"categories":["Community Resources"],"sub_categories":["Static Analysis"],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://hsto.org/webt/jj/z4/-o/jjz4-ofmx_k18yeslacjnjuzrve.png\" width=\"128\" alt=\"icon\"\u003e\n\u003c/p\u003e\n\n# Linter for markdown \u003csub\u003e\u003csup\u003e| with presets\u003c/sup\u003e\u003c/sub\u003e\n\n![Release][badge_release]\n[![Build][badge_ci]][link_actions]\n[![Build][badge_build]][link_hub]\n[![Docker Pulls][badge_pulls]][link_hub]\n[![Issues][badge_issues]][link_issues]\n[![License][badge_license]][link_license]\n\nThis repository contains source files of docker image (and [github action][github_actions_doc]) for markdown files linting. Additionally we provides setting _(rules)_ for the most useful cases, like changelog file linting.\n\nAll docker images always can be found on **[this page][link_hub_tags]**.\n\n## Usage\n\nThis image contains [markdownlint-cli][markdownlint-cli] (node-js) and:\n\n- Additional rules for `changelog` file linting _(`/lint/rules/changelog.js`)_\n- Configuration file for `changelog` file linting _(it uses additional linting rules, `/lint/config/changelog.yml`)_\n\n\u003e Major image tag can be updated in any time, but all changes will be backwards compatible.\n\n`markdownlint-cli` supports next options (more details can be found [on project page][markdownlint-cli]):\n\n```bash\nUsage: markdownlint [options] \u003cfiles|directories|globs\u003e\n\nOptions:\n  -h, --help                                  output usage information\n  -V, --version                               output the version number\n  -f, --fix                                   fix basic errors (does not work with STDIN)\n  -s, --stdin                                 read from STDIN (does not work with files)\n  -o, --output [outputFile]                   write issues to file (no console)\n  -c, --config [configFile]                   configuration file (JSON, JSONC, or YAML)\n  -i, --ignore [file|directory|glob]          files to ignore/exclude\n  -r, --rules  [file|directory|glob|package]  custom rule files\n```\n\n### Environment variables\n\nSome linter execution options can be passed through environment variables _(multiple variables usage are allowed)_:\n\nEnvironment variable    | Interpretation\n----------------------- | --------------\n`INPUT_RULES=/foo.js`   | `markdownlint --rules /foo.js ...`\n`INPUT_CONFIG=/bar.yml` | `markdownlint --config /bar.yml ...`\n`INPUT_FIX=true`        | `markdownlint --fix ...`\n`INPUT_OUTPUT=/foo`     | `markdownlint --output /foo ...`\n`INPUT_IGNORE=/bar`     | `markdownlint --ignore /bar ...`\n\n### Docker\n\nFor example, you can lint your `CHANGELOG.md` file using following command:\n\n```bash\n$ docker run --rm \\\n    -v \"$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro\" \\\n    avtodev/markdown-lint:v1 \\\n    --rules /lint/rules/changelog.js \\\n    --config /lint/config/changelog.yml \\\n    /CHANGELOG.md\n```\n\nor\n\n```bash\n$ docker run --rm \\\n    -v \"$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro\" \\\n    -e INPUT_RULES=/lint/rules/changelog.js \\\n    -e INPUT_CONFIG=/lint/config/changelog.yml \\\n    avtodev/markdown-lint:v1 \\\n    /CHANGELOG.md\n```\n\n### GitHub Actions\n\n```yaml\njobs:\n  lint-changelog:\n    name: Lint changelog file\n    runs-on: ubuntu-latest\n    steps:\n    - name: Check out code\n      uses: actions/checkout@v2\n\n    - name: Lint changelog file\n      uses: docker://avtodev/markdown-lint:v1 # fastest way\n      with:\n        rules: '/lint/rules/changelog.js'\n        config: '/lint/config/changelog.yml'\n        args: './CHANGELOG.md'\n        ignore: './one_file.md ./another_file.md' # multiple files must be separated with single space\n\n    # Or using current repository as action:\n\n    - name: Lint changelog file\n      uses: avto-dev/markdown-lint@v1\n      with:\n        rules: '/lint/rules/changelog.js'\n        config: '/lint/config/changelog.yml'\n        args: './CHANGELOG.md'\n```\n\n### License\n\nMIT. Use anywhere for your pleasure.\n\n[badge_release]:https://img.shields.io/github/v/release/avto-dev/markdown-lint?include_prereleases\u0026style=flat-square\u0026maxAge=10\n[badge_ci]:https://img.shields.io/github/actions/workflow/status/avto-dev/markdown-lint/ci.yml\n[badge_pulls]:https://img.shields.io/docker/pulls/avtodev/markdown-lint.svg?style=flat-square\u0026maxAge=30\n[badge_issues]:https://img.shields.io/github/issues/avto-dev/markdown-lint.svg?style=flat-square\u0026maxAge=30\n[badge_build]:https://img.shields.io/docker/v/avtodev/markdown-lint\n[badge_license]:https://img.shields.io/github/license/avto-dev/markdown-lint.svg?style=flat-square\u0026maxAge=30\n[link_hub]:https://hub.docker.com/r/avtodev/markdown-lint/\n[link_hub_tags]:https://hub.docker.com/r/avtodev/markdown-lint/tags\n[link_license]:https://github.com/avto-dev/markdown-lint/blob/master/LICENSE\n[link_issues]:https://github.com/avto-dev/markdown-lint/issues\n[link_actions]:https://github.com/avto-dev/markdown-lint/actions\n[markdownlint-cli]:https://github.com/igorshubovych/markdownlint-cli\n[github_actions_doc]:https://help.github.com/en/actions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favto-dev%2Fmarkdown-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favto-dev%2Fmarkdown-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favto-dev%2Fmarkdown-lint/lists"}