{"id":26055629,"url":"https://github.com/john0isaac/markdown-checker","last_synced_at":"2025-06-25T17:10:17.278Z","repository":{"id":208381119,"uuid":"721497004","full_name":"john0isaac/markdown-checker","owner":"john0isaac","description":"Markdown Links Validation Reporting Tool","archived":false,"fork":false,"pushed_at":"2025-05-05T16:49:07.000Z","size":138,"stargazers_count":2,"open_issues_count":9,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-22T23:31:09.141Z","etag":null,"topics":["cli","markdown","pypi","python","tool"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/markdown-checker","language":"Python","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/john0isaac.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null},"funding":{"github":"john0isaac","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2023-11-21T07:24:13.000Z","updated_at":"2025-05-05T16:48:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"230c8d16-c92e-4126-8d08-416bb4fea23e","html_url":"https://github.com/john0isaac/markdown-checker","commit_stats":null,"previous_names":["john0isaac/markdown-checker"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/john0isaac/markdown-checker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john0isaac%2Fmarkdown-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john0isaac%2Fmarkdown-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john0isaac%2Fmarkdown-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john0isaac%2Fmarkdown-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/john0isaac","download_url":"https://codeload.github.com/john0isaac/markdown-checker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john0isaac%2Fmarkdown-checker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261917439,"owners_count":23229919,"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":["cli","markdown","pypi","python","tool"],"created_at":"2025-03-08T10:20:07.298Z","updated_at":"2025-06-25T17:10:17.237Z","avatar_url":"https://github.com/john0isaac.png","language":"Python","funding_links":["https://github.com/sponsors/john0isaac"],"categories":[],"sub_categories":[],"readme":"[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)\n[![Documentation Status](https://readthedocs.org/projects/markdown-checker/badge/?version=latest)](https://markdown-checker.readthedocs.io/en/latest/?badge=latest)\n[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)\n\n[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markdown-checker/issues)\n[![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://github.com/john0isaac/markdown-checker/pulls)\n\nmarkdown-checker is a markdown link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.\n\n## Installation\n\nInstall the package:\n\n```bash\npip install markdown-checker\n```\n\n### Documentation\n\n- [Full documentation](https://markdown-checker.readthedocs.io/en/latest/).\n\n## 1, 2, 3 - How To\n\n1. Run `pip install markdown-checker`.\n2. Run `markdown-checker -d {src} -f {func} -gu {url}`. Replace `{src}` with the directory you want to analyze, `{func}` with the available functions like `check_broken_paths`, `{gu}` with your contribution guidance full URL.\n3. The output will be displayed in the terminal and in a `comment.md` file.\n\nFor more customizations read the docs.\n\n## Using `markdown-checker` in GitHub Actions\n\nYou can run this tool within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action.\n\nThe action will automatically post the output of the tool to your GitHub pull request as a comment.\n\n# Usage\n\nThe library provides the following functions:\n\n- [Usage](#usage)\n  - [`check_broken_paths`](#check_broken_paths)\n  - [`check_broken_urls`](#check_broken_urls)\n  - [`check_urls_locale`](#check_urls_locale)\n  - [`check_paths_tracking`](#check_paths_tracking)\n  - [`check_urls_tracking`](#check_urls_tracking)\n\n## `check_broken_paths`\n\nThis function ensures that any relative path in your files are working.\n\nExample:\n\n```bash\nmarkdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md\n```\n\n## `check_broken_urls`\n\nThis function ensures that any web URL in your files is working and returning 200 status code.\n\nExample:\n\n```bash\nmarkdown-checker -d . -f check_broken_urls -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md\n```\n\n## `check_urls_locale`\n\nThis function checks if country specific locale is present in URLs.\n\nExample:\n\n```bash\nmarkdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md\n```\n\n## `check_paths_tracking`\n\nThis function ensures that any relative path has tracking in it.\n\nExample:\n\n```bash\nmarkdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md\n```\n\n## `check_urls_tracking`\n\nThis function ensures that any URL has tracking in it.\n\nExample:\n\n```bash\nmarkdown-checker -d . -f check_urls_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn0isaac%2Fmarkdown-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohn0isaac%2Fmarkdown-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn0isaac%2Fmarkdown-checker/lists"}