{"id":13410929,"url":"https://github.com/DavidAnson/markdownlint-cli2-action","last_synced_at":"2025-03-14T16:33:21.234Z","repository":{"id":44598552,"uuid":"329203602","full_name":"DavidAnson/markdownlint-cli2-action","owner":"DavidAnson","description":"A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with the markdownlint library","archived":false,"fork":false,"pushed_at":"2024-10-21T15:41:35.000Z","size":2848,"stargazers_count":92,"open_issues_count":0,"forks_count":11,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-24T15:45:23.692Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/markdownlint-cli2-action","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/DavidAnson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"DavidAnson"}},"created_at":"2021-01-13T05:28:45.000Z","updated_at":"2024-10-21T15:41:32.000Z","dependencies_parsed_at":"2023-02-16T11:31:19.268Z","dependency_job_id":"5658b0fe-a1c7-4528-8079-cb61e8d94c72","html_url":"https://github.com/DavidAnson/markdownlint-cli2-action","commit_stats":{"total_commits":278,"total_committers":2,"mean_commits":139.0,"dds":"0.42805755395683454","last_synced_commit":"bce62fc0a09de648c7f221ee0896b054912b6b55"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidAnson%2Fmarkdownlint-cli2-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidAnson%2Fmarkdownlint-cli2-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidAnson%2Fmarkdownlint-cli2-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidAnson%2Fmarkdownlint-cli2-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DavidAnson","download_url":"https://codeload.github.com/DavidAnson/markdownlint-cli2-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243253844,"owners_count":20261662,"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":[],"created_at":"2024-07-30T20:01:10.274Z","updated_at":"2025-03-14T16:33:21.196Z","avatar_url":"https://github.com/DavidAnson.png","language":"JavaScript","readme":"# markdownlint-cli2-action\n\n\u003e A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool for\nlinting [Markdown][markdown]/[CommonMark][commonmark] files with\n[`markdownlint`][markdownlint]\n\n`markdownlint-cli2` has extensive support for configuring options and disabling\nor customizing `markdownlint` rules. See the\n[`markdownlint-cli2` README][markdownlint-cli2] for more information.\n`markdownlint` includes a wide variety of rules for analyzing and improving\nMarkdown content. See the [`markdownlint` README][markdownlint] for more\ninformation.\n\n## Inputs\n\n### config (optional)\n\nPath of a file to use for the base configuration object (defaults to none)\n\nEquivalent to using the `--config` [command-line option][command-line] and\npassing the specified configuration file.\n\n### fix (optional)\n\nWhether to fix supported issues automatically (any truthy value enables)\n\nEquivalent to specifying the `--fix` [command-line option][command-line].\n\n### globs (optional)\n\nGlob expression(s) of files to lint (newline-delimited by default)\n\nThe default `*.{md,markdown}` lints all Markdown files in the base directory of\na project.\n\nFor more detail: [glob syntax in `markdownlint-cli2`][glob-syntax].\n\n### separator (optional)\n\nString to use as a separator for the `globs` input (defaults to newline)\n\nAllows the `globs` input to use something other than `\\n` to separate glob\nexpressions.\n\n## Outputs\n\n[None]\n\n## Examples\n\nTo lint Markdown files in the base directory of a project:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n```\n\nTo lint all Markdown files in a project:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  with:\n    globs: '**/*.md'\n```\n\nTo lint specific Markdown files in a project:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  with:\n    globs: |\n      README.md\n      CHANGELOG.md\n      docs/*.md\n```\n\nTo use a custom separator:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  with:\n    globs: 'README.md,CHANGELOG.md,docs/*.md'\n    separator: ','\n```\n\nTo fix supported issues when linting:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  with:\n    fix: true\n    globs: '**/*.md'\n```\n\nTo specify a custom configuration file:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  with:\n    config: 'config/custom.markdownlint.jsonc'\n    globs: '**/*.md'\n```\n\nTo prevent linting issues from failing the workflow run:\n\n```yaml\n- uses: DavidAnson/markdownlint-cli2-action@v19\n  continue-on-error: true\n```\n\nSee [`example.yml`][example-yml] for a simple GitHub workflow that uses\n`markdownlint-cli2-action`.\n\nSee [`changed.yml`][changed-yml] for a GitHub workflow that lints only the\nMarkdown files that changed in the most recent commit (useful for Pull Requests\nand/or gradually introducing linting rules to a new repository).\n\n[changed-yml]: .github/workflows/changed.yml\n[command-line]: https://github.com/DavidAnson/markdownlint-cli2#command-line\n[commonmark]: https://commonmark.org/\n[example-yml]: .github/workflows/example.yml\n[glob-syntax]: https://github.com/DavidAnson/markdownlint-cli2#use\n[markdown]: https://wikipedia.org/wiki/Markdown\n[markdownlint]: https://github.com/DavidAnson/markdownlint\n[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2\n","funding_links":["https://github.com/sponsors/DavidAnson"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDavidAnson%2Fmarkdownlint-cli2-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDavidAnson%2Fmarkdownlint-cli2-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDavidAnson%2Fmarkdownlint-cli2-action/lists"}