{"id":13494866,"url":"https://github.com/markdownlint/markdownlint","last_synced_at":"2025-05-15T09:06:37.458Z","repository":{"id":17584896,"uuid":"20388420","full_name":"markdownlint/markdownlint","owner":"markdownlint","description":"Markdown lint tool","archived":false,"fork":false,"pushed_at":"2024-01-12T13:18:03.000Z","size":510,"stargazers_count":1804,"open_issues_count":146,"forks_count":228,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-10-29T17:51:56.017Z","etag":null,"topics":["markdown","markdownlint","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/markdownlint.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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}},"created_at":"2014-06-01T23:05:35.000Z","updated_at":"2024-10-29T03:08:12.000Z","dependencies_parsed_at":"2023-11-20T01:42:26.400Z","dependency_job_id":"5db94849-7de7-444a-99d0-305b1d377cc4","html_url":"https://github.com/markdownlint/markdownlint","commit_stats":null,"previous_names":["mivok/markdownlint"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdownlint%2Fmarkdownlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdownlint%2Fmarkdownlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdownlint%2Fmarkdownlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdownlint%2Fmarkdownlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markdownlint","download_url":"https://codeload.github.com/markdownlint/markdownlint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310515,"owners_count":22049469,"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":["markdown","markdownlint","ruby"],"created_at":"2024-07-31T19:01:28.982Z","updated_at":"2025-05-15T09:06:37.407Z","avatar_url":"https://github.com/markdownlint.png","language":"Ruby","readme":"# Markdown lint tool\n\n[![Continuous Integration](https://github.com/markdownlint/markdownlint/workflows/Continuous%20Integration/badge.svg)](https://github.com/markdownlint/markdownlint/actions?query=workflow%3A%22Continuous+Integration%22)\n[![Gem Version](https://badge.fury.io/rb/mdl.svg)](https://badge.fury.io/rb/mdl)\n\nA tool to check markdown files and flag style issues.\n\n## Installation\n\nMarkdownlint is packaged in some distributions as well as distributed via\nRubyGems. Check the list below to see if it's packaged for your distribution,\nand if so, feel free to use your distros package manager to install it.\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/mdl-markdownlint.svg?exclude_unsupported=1)](https://repology.org/project/mdl-markdownlint/versions)\n\nTo install from rubygems, run:\n\n```shell\ngem install mdl\n```\n\nAlternatively you can build it from source:\n\n```shell\ngit clone https://github.com/markdownlint/markdownlint\ncd markdownlint\nrake install\n```\n\nNote that you will need [rake](https://github.com/ruby/rake)\n(`gem install rake`) and [bundler](https://github.com/bundler/bundler)\n(`gem install bundler`) in order to build from source.\n\n## Usage\n\nTo have markdownlint check your markdown files, simply run `mdl` with the\nfilenames as a parameter:\n\n```shell\nmdl README.md\n```\n\nMarkdownlint can also take a directory, and it will scan all markdown files\nwithin the directory (and nested directories):\n\n```shell\nmdl docs/\n```\n\nIf you don't specify a filename, markdownlint will use stdin:\n\n```shell\ncat foo.md | mdl\n```\n\nMarkdownlint will output a list of issues it finds, and the line number where\nthe issue is. See [RULES.md](docs/RULES.md) for information on each issue, as\nwell as how to correct it:\n\n```shell\nREADME.md:1: MD013 Line length\nREADME.md:70: MD029 Ordered list item prefix\nREADME.md:71: MD029 Ordered list item prefix\nREADME.md:72: MD029 Ordered list item prefix\nREADME.md:73: MD029 Ordered list item prefix\n```\n\nMarkdownlint has many more options you can pass on the command line, run\n`mdl --help` to see what they are, or see the documentation on\n[configuring markdownlint](docs/configuration.md).\n\n### Styles\n\nNot everyone writes markdown in the same way, and there are multiple flavors\nand styles, each of which are valid. While markdownlint's default settings\nwill result in markdown files that reflect the author's preferred markdown\nauthoring preferences, your project may have different guidelines.\n\nIt's not markdownlint's intention to dictate any one specific style, and in\norder to support these differing styles and/or preferences, markdownlint\nsupports what are called 'style files'. A style file is a file describing\nwhich rules markdownlint should enable, and also what settings to apply to\nindividual rules. For example, rule [MD013](docs/RULES.md#md013---line-length)\nchecks for long lines, and by default will report an issue for any line longer\nthan 80 characters. If your project has a different maximum line length limit,\nor if you don't want to enforce a line limit at all, then this can be\nconfigured in a style file.\n\nFor more information on creating style files, see the\n[creating styles](docs/creating_styles.md) document.\n\n### Custom rules and rulesets\n\nIt may be that the rules provided in this project don't cover your stylistic\nneeds. To account for this, markdownlint supports the creation and use of custom\nrules.\n\nFor more information, see the [creating rules](docs/creating_rules.md) document.\n\n## Related projects\n\n- [markdownlint](https://github.com/DavidAnson/markdownlint) - A similar\n  project, but limited in Node.js\n- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) - A CLI\n  for the above Node.js project\n- [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) - An\n  alternative CLI for the Node.js project\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more information.\n","funding_links":[],"categories":["Spell Checking and Linting","Ruby","Tools","Tools \u0026 Services","Awesome Ruby CLIs","Uncategorized"],"sub_categories":["Linters","Individual Episodes","Linting","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdownlint%2Fmarkdownlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkdownlint%2Fmarkdownlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdownlint%2Fmarkdownlint/lists"}