{"id":19583707,"url":"https://github.com/actionshub/markdownlint","last_synced_at":"2025-04-27T10:32:54.979Z","repository":{"id":48499890,"uuid":"231902677","full_name":"actionshub/markdownlint","owner":"actionshub","description":"Repository for the markdownlint-mdl-action Github Action","archived":false,"fork":false,"pushed_at":"2023-12-26T22:32:38.000Z","size":45,"stargazers_count":24,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-05T18:32:30.942Z","etag":null,"topics":["action","ci","github-action","markdownlint","terraform-managed"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/markdownlint-mdl-action","language":"Shell","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/actionshub.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,"governance":null,"roadmap":null,"authors":null},"funding":{"open_collective":"actionshub"}},"created_at":"2020-01-05T10:45:53.000Z","updated_at":"2024-06-25T21:46:48.000Z","dependencies_parsed_at":"2024-01-01T14:24:56.310Z","dependency_job_id":null,"html_url":"https://github.com/actionshub/markdownlint","commit_stats":{"total_commits":40,"total_committers":12,"mean_commits":"3.3333333333333335","dds":0.75,"last_synced_commit":"6c82ff529253530dfbf75c37570876c52692835f"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionshub%2Fmarkdownlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionshub%2Fmarkdownlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionshub%2Fmarkdownlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionshub%2Fmarkdownlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actionshub","download_url":"https://codeload.github.com/actionshub/markdownlint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223885627,"owners_count":17219607,"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":["action","ci","github-action","markdownlint","terraform-managed"],"created_at":"2024-11-11T07:44:13.370Z","updated_at":"2024-11-11T07:44:14.544Z","avatar_url":"https://github.com/actionshub.png","language":"Shell","funding_links":["https://opencollective.com/actionshub"],"categories":[],"sub_categories":[],"readme":"# Markdown Lint\n\n[![CI State](https://github.com/actionshub/markdownlint/workflows/release/badge.svg)](https://github.com/actionshub/markdownlint)\n\nA Github Action to run mdl on your files\n\n## Inputs\n\n### `path`\n\nPath to scan for markdown files within the directory (and nested directories) `mdl`\n\n### `filesToIgnoreRegex`\n\nA regex of files you do not want scanned, note: cannot be used with `path` input\n\n## Outputs\n\n### `output`\n\nThe output from `mdl`\n\n## Usage\n\n```yaml\nname: markdownlint\n\non: [push, pull_request]\n\njobs:\n  delivery:\n    runs-on: ubuntu-latest\n    steps:\n    - name: Check out code\n      uses: actions/checkout@v2\n    - name: Run mdl\n      uses: actionshub/markdownlint@main\n```\n\n### With Ignore files\n\n```yaml\nname: markdownlint\n\non: [push, pull_request]\n\njobs:\n  mdl:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Check out code\n        uses: actions/checkout@v2\n      - name: Run Markdown Lint\n        uses: actionshub/markdownlint@main\n        with:\n          filesToIgnoreRegex: \"node_modules\\\\/.*\"\n```\n\n## Configuration\n\n`markdownlint` can use a config file called `.mdlrc` this can be found in the [documentation](https://github.com/markdownlint/markdownlint/blob/master/docs/configuration.md)\n\nFor more complex configuration, you may wish to use a Ruby style file.\nIn this case, your `.mdlrc` file should contain a link to the style file:\n\n```sh\nstyle '.mdl.rb'\n```\n\nwhich can contain arbitrary Ruby code:\n\n```rb\n# Enable all rules by default\nall\n\n# Extend line length, since each sentence should be on a separate line.\nrule 'MD013', :line_length =\u003e 99999\n\n# Allow in-line HTML\nexclude_rule 'MD033'\n\n# Nested lists should be indented with four spaces.\nrule 'MD007', :indent =\u003e 4\n```\n\nMore information can be found in the [mdl documentation](https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md).\n\n## Markdown link checker\n\nIt may also be worth looking into a [markdown link checker](https://github.com/gaurav-nelson/github-action-markdown-link-check)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factionshub%2Fmarkdownlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factionshub%2Fmarkdownlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factionshub%2Fmarkdownlint/lists"}