{"id":16772580,"url":"https://github.com/jonlabelle/sublimelinter-contrib-markdownlint","last_synced_at":"2025-03-17T02:31:31.166Z","repository":{"id":52425892,"uuid":"105429078","full_name":"jonlabelle/SublimeLinter-contrib-markdownlint","owner":"jonlabelle","description":"A Sublime Text Linter for Markdown/CommonMark files.","archived":false,"fork":false,"pushed_at":"2024-04-26T23:02:45.000Z","size":117,"stargazers_count":34,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-27T16:47:34.107Z","etag":null,"topics":["linter","markdown","plugin","python","sublime-text","sublimelinter"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/jonlabelle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-01T08:33:01.000Z","updated_at":"2024-04-26T23:02:42.000Z","dependencies_parsed_at":"2024-08-02T13:20:27.636Z","dependency_job_id":null,"html_url":"https://github.com/jonlabelle/SublimeLinter-contrib-markdownlint","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonlabelle%2FSublimeLinter-contrib-markdownlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonlabelle%2FSublimeLinter-contrib-markdownlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonlabelle%2FSublimeLinter-contrib-markdownlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonlabelle%2FSublimeLinter-contrib-markdownlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonlabelle","download_url":"https://codeload.github.com/jonlabelle/SublimeLinter-contrib-markdownlint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243841125,"owners_count":20356440,"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":["linter","markdown","plugin","python","sublime-text","sublimelinter"],"created_at":"2024-10-13T06:43:16.151Z","updated_at":"2025-03-17T02:31:30.704Z","avatar_url":"https://github.com/jonlabelle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sublime Text Markdownlint\n\n[![build status](https://github.com/jonlabelle/SublimeLinter-contrib-markdownlint/workflows/ci/badge.svg?branch=master)](https://github.com/jonlabelle/SublimeLinter-contrib-markdownlint/actions \"build status\")\n[![Package Control Installs](https://img.shields.io/packagecontrol/dt/SublimeLinter-contrib-markdownlint.svg?label=installs)](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint \"Package Control Installs\")\n[![Latest Version](https://img.shields.io/github/tag/jonlabelle/SublimeLinter-contrib-markdownlint.svg?label=version)](https://github.com/jonlabelle/SublimeLinter-contrib-markdownlint/releases \"Latest Version\")\n[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/jonlabelle/SublimeLinter-contrib-markdownlint/blob/master/LICENSE.txt)\n\n\u003e A Sublime Text plug-in for linting Markdown/CommonMark files.\n\n![Markdownlint Screenshot](screenshots/screenshot.png \"Markdownlint Screenshot\")\n\n## Installing\n\n[SublimeLinter] must be installed in order to use this plug-in. If\nSublimeLinter is not installed, please follow the instructions outlined\n[here][installation].\n\n### Install Markdownlint\n\nBefore using this plug-in, you must ensure that [markdownlint][CLI] is\ninstalled on your system. To install `markdownlint`, do the following:\n\n1. Install [Node.js](http://nodejs.org).\n2. Install `markdownlint` by typing the following in a terminal:\n\n  ```\n      npm install -g markdownlint-cli\n  ```\n\n3. If you are using `nvm` and `zsh`, ensure that the line to load `nvm` is in\n   `.zshenv` and not `.zshrc`.\n4. If you are using `zsh` and `oh-my-zsh`, do not load the `nvm` plug-in for\n   `oh-my-zsh`.\n\n### Install Sublime Text Markdownlint\n\nPlease use [Package Control][pc] to install Sublime Text Markdownlint. This will\nensure that the plug-in will be updated when new versions are available. If you\nwant to install from source so you can modify the source code, you probably know\nwhat you are doing so we won't cover that here.\n\nTo install via [Package Control][pc], do the following:\n\n1. Within Sublime Text, bring up the [Command Palette][cmd] and type `install`.\n   Among the commands you should see `Package Control: Install Package`. If that\n   command is not highlighted, use the keyboard or mouse to select it. There\n   will be a pause of a few seconds while Package Control fetches the list of\n   available plug-ins.\n\n2. When the plug-in list appears, type `markdownlint`. Among the entries you\n   should see `SublimeLinter-contrib-markdownlint`. If that entry is not\n   highlighted, use the keyboard or mouse to select it.\n\n### Markdownlint Configuration Files\n\nMarkdownlint configuration files (`.markdownlintrc`) are resolved first by\nchecking the source directory of file being linted, then by checking the user\n`$HOME` path.\n\nTo specify a custom Markdownlint configuration path, create a **markdownlint**\nsection under **linters** in your SublimeLinter User Settings\n(`SublimeLinter.sublime-settings`). Then add an `args` key with the appropriate\npath to your `--config` file. For example:\n\n```json\n{\n    \"linters\": {\n        \"markdownlint\": {\n            \"args\": [\"--config\", \"/custom/path/to/.markdownlintrc\"]\n        }\n    }\n}\n```\n\n## Contributing\n\nIf you would like to contribute enhancements or fixes, please do the following:\n\n1. Fork the plug-in repository.\n2. Hack on a separate topic branch created from the latest `master`.\n3. Commit and push the topic branch.\n4. Make a pull request.\n5. Be patient.\n\nPlease note that modifications should follow these coding guidelines:\n\n- Indent is 4 spaces.\n- Code should pass flake8 and pep257 linters.\n- Vertical whitespace helps readability, don't be afraid to use it.\n- Please use descriptive variable names, no abbreviations unless they are very\n  well known.\n\n## Author\n\nJon LaBelle\n\n## License\n\n[MIT License]\n\n[SublimeLinter]: http://www.sublimelinter.com/en/stable/\n[docs]: http://www.sublimelinter.com/en/stable/\n[installation]: http://www.sublimelinter.com/en/stable/\n[locating-executables]: http://www.sublimelinter.com/en/stable/troubleshooting.html#finding-a-linter-executable\n[pc]: https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint\n[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html\n[settings]: http://www.sublimelinter.com/en/stable/settings.html\n[linter-settings]: http://www.sublimelinter.com/en/stable/linter_settings.html\n[markdownlint]: https://github.com/DavidAnson/markdownlint\n[`markdownlint`]: https://github.com/DavidAnson/markdownlint\n[CLI]: https://github.com/igorshubovych/markdownlint-cli\n[MIT License]: LICENSE.txt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonlabelle%2Fsublimelinter-contrib-markdownlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonlabelle%2Fsublimelinter-contrib-markdownlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonlabelle%2Fsublimelinter-contrib-markdownlint/lists"}