{"id":41736911,"url":"https://github.com/open-ch/checkdoc","last_synced_at":"2026-01-25T00:07:09.983Z","repository":{"id":57558197,"uuid":"263304006","full_name":"open-ch/checkdoc","owner":"open-ch","description":"Basic markdown documentation checker/linter: enforce basic quality standards for your repository's documentation.","archived":false,"fork":false,"pushed_at":"2026-01-23T16:02:50.000Z","size":318,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-24T02:41:21.255Z","etag":null,"topics":["documentation","linter","markdown"],"latest_commit_sha":null,"homepage":"","language":"Go","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/open-ch.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-12T10:22:42.000Z","updated_at":"2026-01-23T16:02:54.000Z","dependencies_parsed_at":"2024-06-20T15:53:11.995Z","dependency_job_id":null,"html_url":"https://github.com/open-ch/checkdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/open-ch/checkdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ch%2Fcheckdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ch%2Fcheckdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ch%2Fcheckdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ch%2Fcheckdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-ch","download_url":"https://codeload.github.com/open-ch/checkdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-ch%2Fcheckdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28739342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T22:12:27.248Z","status":"ssl_error","status_checked_at":"2026-01-24T22:12:10.529Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","linter","markdown"],"created_at":"2026-01-25T00:07:09.905Z","updated_at":"2026-01-25T00:07:09.973Z","avatar_url":"https://github.com/open-ch.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# checkdoc\n\n`checkdoc` is a tool that helps you assess if a markdown documentation tree is in good shape, at least from a linking perspective.\n\nIts main goal is to enforce minimal quality standards in a repository's documentation.\n\nIt will tell you if:\n\n  - Markdown files are not referenced (directly or through other files) from a readme in the root directory\n    of a repository\n  - There are broken internal links\n\n## Sample Usage\n\nUsed on this repository, checkdoc yields the following:\n```\n$ checkdoc verify\nINFO Running verify on tree root /tmp/checkdoc\nINFO Considering basenames [] and extensions [.md]\nDEBU Found 1 nodes at:\nDEBU    README.md:\nINFO Checking for orphaned documents...\nINFO No orphans found.\nINFO Checking for dead links...\nERRO Located some files with dead links:\nERRO    README.md\nERRO       CHANGELOG.md\nERRO Verify failed on tree root /tmp/checkdoc\n```\n\nAs shown above, it detects that we have a dead link to a non-existing file.\n\n## Installation\n\n```\ngo install github.com/open-ch/checkdoc@latest\n```\n\nThen run it with `checkdoc`, assuming your `$GOPATH/bin` is on your `PATH`. You should see something along these lines:\n```\ncheckdoc\nA markdown documentation validator intended to enforce a healthy documentation in settings such as a fat repo.\n\nUsage:\n  checkdoc [command]\n\nAvailable Commands:\n  help        Help about any command\n  verify      Runs sanity checks on the documentation\n\nFlags:\n  -h, --help           help for checkdoc\n  -r, --root string    Path to the root of the markdown documentation hierarchy to validate (default \".\")\n  -g, --use-git-root   from the given root, fall back to the repository's root. This will cause checkdoc to fail if --root is not pointing to a repository. (default true)\n\nUse \"checkdoc [command] --help\" for more information about a command.\n```\n\n## Note For GitHub Readers\n\nWhile the content of this module is managed in an internal repository,\nyou may still submit PR's.\n\n## License\n\nPlease see the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-ch%2Fcheckdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-ch%2Fcheckdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-ch%2Fcheckdoc/lists"}