{"id":15683688,"url":"https://github.com/zemanlx/remark-lint","last_synced_at":"2025-10-27T15:46:22.536Z","repository":{"id":29763371,"uuid":"122249707","full_name":"zemanlx/remark-lint","owner":"zemanlx","description":"Docker image for remark-lint markdown code style linter","archived":false,"fork":false,"pushed_at":"2025-02-20T17:18:17.000Z","size":351,"stargazers_count":5,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-07T14:11:41.993Z","etag":null,"topics":["continuous-integration","dead-links","docker-image","linter","markdown","remark-lint"],"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/zemanlx.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-20T20:07:05.000Z","updated_at":"2025-02-20T17:16:46.000Z","dependencies_parsed_at":"2025-03-11T05:32:47.138Z","dependency_job_id":"cbe0e12e-4303-4c8d-9347-6e49529ea531","html_url":"https://github.com/zemanlx/remark-lint","commit_stats":{"total_commits":51,"total_committers":3,"mean_commits":17.0,"dds":"0.43137254901960786","last_synced_commit":"2cd87b75f0a41280eb66a4e2c9962647c4949f25"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemanlx%2Fremark-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemanlx%2Fremark-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemanlx%2Fremark-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemanlx%2Fremark-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zemanlx","download_url":"https://codeload.github.com/zemanlx/remark-lint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252892504,"owners_count":21820648,"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":["continuous-integration","dead-links","docker-image","linter","markdown","remark-lint"],"created_at":"2024-10-03T17:08:12.424Z","updated_at":"2025-10-27T15:46:17.488Z","avatar_url":"https://github.com/zemanlx.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker image for remark-lint\n\n![Build Status](https://github.com/zemanlx/remark-lint/actions/workflows/docker-publish.yml/badge.svg)\n\nDocker image for markdown code style linter [remark-lint](https://github.com/remarkjs/remark-lint).\n\n## Get\n\nPull image from [GitHub Container Registry](https://ghcr.io/zemanlx/remark-lint)\n\n```bash\ndocker pull ghcr.io/zemanlx/remark-lint\n```\n\n## Build\n\nClone this repository and run\n\n```bash\ndocker build -t ghcr.io/zemanlx/remark-lint .\n```\n\n## Use\n\nGo to your folder with markdown files you want to lint and run\n\n```bash\ndocker run --rm -i -v $PWD:/lint/input:ro ghcr.io/zemanlx/remark-lint .\n```\n\nYou can even set it up as an alias for remark-cli's command `remark`.\n\n```bash\nalias remark=\"docker run --rm -i -v $PWD:/lint/input:ro ghcr.io/zemanlx/remark-lint\"\n\nremark --version\nremark: 14.0.2, remark-cli: 10.0.1\n```\n\nDefault config is `.remarkrc.yaml`\n\n```yaml\nplugins:\n  preset-lint-consistent:\n  preset-lint-markdown-style-guide:\n  preset-lint-recommended:\n  validate-links:\n```\n\n### Example\n\n```bash\ndocker run --rm -i -v $PWD:/lint/input:ro ghcr.io/zemanlx/remark-lint .\n\nREADME.md\n  3:100  warning  Line must be at most 80 characters  maximum-line-length         remark-lint\n    8:1  warning  Remove 1 line before node           no-consecutive-blank-lines  remark-lint\n\n⚠ 2 warnings\n```\n\n### Rule Customisation\n\nIn case you want to customize rules like `maximum-line-length` you can find\nexamples of configuration in JSON and YAML in the `examples` folder. All you\nneed to do is copy it to your project root and customize.\n\nSee list of all rules in [remark-lint/packages](https://github.com/remarkjs/remark-lint/tree/master/packages).\n\n### Continuous Integration\n\nAn option `-f` or `--frail` can be useful for exiting with code `1` in case of\nany warning in your CI.\n\n```bash\ndocker run --rm -i -v $PWD:/lint/input:ro ghcr.io/zemanlx/remark-lint --frail .\n```\n\n#### Travis CI\n\nYour minimal configuration can look like\n\n```yaml\n# Docker is required to run the linter\nsudo: required\nservices:\n  - docker\n# Use your language or generic image to cut start-up time\nlanguage: generic\ninstall:\n  - docker pull ghcr.io/zemanlx/remark-lint\nscript:\n  - docker run --rm -i -v $PWD:/lint/input:ro ghcr.io/zemanlx/remark-lint --frail .\n```\n\nYou can extend this example with your build instructions and tests or add it\nas a job to one of your stages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemanlx%2Fremark-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzemanlx%2Fremark-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemanlx%2Fremark-lint/lists"}