{"id":14013095,"url":"https://github.com/pawamoy/mkdocs-coverage","last_synced_at":"2025-04-11T20:42:40.136Z","repository":{"id":65332134,"uuid":"335718785","full_name":"pawamoy/mkdocs-coverage","owner":"pawamoy","description":"MkDocs plugin to integrate your coverage HTML report into your site.","archived":false,"fork":false,"pushed_at":"2024-06-11T18:47:29.000Z","size":1908,"stargazers_count":27,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-25T16:51:26.933Z","etag":null,"topics":["coverage","coverage-report","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://pawamoy.github.io/mkdocs-coverage","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pawamoy.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pawamoy","ko_fi":"pawamoy","polar":"pawamoy","custom":["https://www.paypal.me/pawamoy"]}},"created_at":"2021-02-03T18:32:20.000Z","updated_at":"2025-03-05T14:42:38.000Z","dependencies_parsed_at":"2024-01-18T20:41:45.161Z","dependency_job_id":"697cae47-deca-4f74-9b45-0049503a3bb5","html_url":"https://github.com/pawamoy/mkdocs-coverage","commit_stats":{"total_commits":36,"total_committers":1,"mean_commits":36.0,"dds":0.0,"last_synced_commit":"0b81616fc5eb6e5be22589fab297f45f7ec4d4fb"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-coverage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-coverage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-coverage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-coverage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pawamoy","download_url":"https://codeload.github.com/pawamoy/mkdocs-coverage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248479442,"owners_count":21110888,"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":["coverage","coverage-report","mkdocs","mkdocs-plugin"],"created_at":"2024-08-11T00:01:05.980Z","updated_at":"2025-04-11T20:42:40.111Z","avatar_url":"https://github.com/pawamoy.png","language":"Python","funding_links":["https://github.com/sponsors/pawamoy","https://ko-fi.com/pawamoy","https://polar.sh/pawamoy","https://www.paypal.me/pawamoy"],"categories":["Python"],"sub_categories":[],"readme":"# MkDocs Coverage Plugin\n\n[![ci](https://github.com/pawamoy/mkdocs-coverage/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-coverage/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-coverage/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocs-coverage.svg)](https://pypi.org/project/mkdocs-coverage/)\n[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/mkdocs-coverage)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#mkdocs-coverage:gitter.im)\n\nMkDocs plugin to integrate your coverage HTML report into your site.\n\n## Installation\n\nWith `pip`:\n\n```bash\npip install mkdocs-coverage\n```\n\nWith [`pipx`](https://github.com/pipxproject/pipx):\n\n```bash\npython3.8 -m pip install --user pipx\npipx install mkdocs-coverage\n```\n\n## Usage\n\n```yaml\n# mkdocs.yml\nnav:\n- Coverage report: coverage.md\n\nplugins:\n- coverage:\n    page_path: coverage  # default\n    html_report_dir: htmlcov  # default\n```\n\nThe page path can be nested:\n\n```yaml\n# mkdocs.yml\nnav:\n- Coverage report: dev/reports/coverage.md\n\nplugins:\n- coverage:\n    page_path: dev/reports/coverage\n```\n\nNow serve your documentation,\nand go to http://localhost:8000/coverage/\nto see your coverage report!\n\n![coverage index](https://user-images.githubusercontent.com/3999221/106802970-f4376a80-6663-11eb-8665-e9e09f0f4ac0.png)\n![coverage module](https://user-images.githubusercontent.com/3999221/106803017-fe596900-6663-11eb-9df9-973755c5b63e.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fmkdocs-coverage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpawamoy%2Fmkdocs-coverage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fmkdocs-coverage/lists"}