{"id":18564276,"url":"https://github.com/notashelf/mdlinkt","last_synced_at":"2025-07-07T05:39:26.802Z","repository":{"id":213965231,"uuid":"735369594","full_name":"NotAShelf/mdlinkt","owner":"NotAShelf","description":"A CLI tool for checking for dead links in a markdown file","archived":false,"fork":false,"pushed_at":"2023-12-29T21:16:42.000Z","size":1428,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-17T13:13:23.335Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotAShelf.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}},"created_at":"2023-12-24T17:02:13.000Z","updated_at":"2023-12-24T17:13:43.000Z","dependencies_parsed_at":"2023-12-24T19:52:27.423Z","dependency_job_id":null,"html_url":"https://github.com/NotAShelf/mdlinkt","commit_stats":null,"previous_names":["notashelf/mdlinkt"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotAShelf%2Fmdlinkt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotAShelf%2Fmdlinkt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotAShelf%2Fmdlinkt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotAShelf%2Fmdlinkt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotAShelf","download_url":"https://codeload.github.com/NotAShelf/mdlinkt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254397769,"owners_count":22064558,"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-11-06T22:14:45.322Z","updated_at":"2025-07-07T05:39:26.796Z","avatar_url":"https://github.com/NotAShelf.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚨 mdlinkt\n\nPractical CLI tool for detecting dead or inaccessible links in markdown files.\n\n## Usage\n\nTo check a markdown file for dead or inaccessible links\n\n```bash\n$ mdlinkt -file your-file.md\n\u003csome output here\u003e\n```\n\nThis will return each tested link and a summary message in an example markdown\nfile containing 1 valid and 1 invalid file. For example, for a `test.md`\ncontaining `https://probablynotvalid.com`:\n\n```bash\n$ mdlinkt -file test.md\n2023/12/12 12:00:00 ERROR Invalid link: https://probablynotvalid.com\n2023/12/12 12:00:00 INFO Summary: 1 valid links, 1 invalid links\n```\n\nShould you want more details on the links that are scanned, you may pass the\n`-verbose` flag.\n\n```bash\n2023/12/12 12:00:00 INFO https://github.com: 200\n2023/12/12 12:00:00 ERROR Invalid link: https://probablynotvalid.com\n2023/12/12 12:00:00 INFO Summary: 1 valid links, 1 invalid links\n```\n\n\u003e [!TIP]\n\u003e In case of invalid links, the program will exit with exit `code 1`, making it\n\u003e perfect for usage in GitHub actions or other pipelines.\n\n### Performance\n\nFor a file containing **10,000 invalid links**, the **Hyperfine** benchmark is\nas follows.\n\n\u003c!-- markdownlint-disable line-length --\u003e\n\n| Command                           |    Mean [ms] | Min [ms] | Max [ms] | Relative |\n| :-------------------------------- | -----------: | -------: | -------: | -------: |\n| `mdlinkt -verbose -file links.md` | 822.2 ± 22.6 |    787.4 |    959.8 |     1.00 |\n\n\u003c!-- markdownlint-enable line-length --\u003e\n\nThe test has been conducted on a **Ryzen 5 3600X**, at a **95 ± 5 MB/s**\nbandwitdh speed.\n\n## Hacking\n\nA nix flake is provided. Use `direnv allow` or `nix develop` to enter the\ndevelopment shell.\n\n### Contributing\n\nPRs are always welcome.\n\n## License\n\nAvailable under the GPLv3. See [LICENSE](LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotashelf%2Fmdlinkt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotashelf%2Fmdlinkt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotashelf%2Fmdlinkt/lists"}