/ README.md
README.md
1 # MkDocs Coverage Plugin 2 3 [](https://github.com/pawamoy/mkdocs-coverage/actions?query=workflow%3Aci) 4 [](https://pawamoy.github.io/mkdocs-coverage/) 5 [](https://pypi.org/project/mkdocs-coverage/) 6 [](https://gitpod.io/#https://github.com/pawamoy/mkdocs-coverage) 7 [](https://app.gitter.im/#/room/#mkdocs-coverage:gitter.im) 8 9 MkDocs plugin to integrate your coverage HTML report into your site. 10 11 ## Installation 12 13 With `pip`: 14 15 ```bash 16 pip install mkdocs-coverage 17 ``` 18 19 With [`pipx`](https://github.com/pipxproject/pipx): 20 21 ```bash 22 python3.8 -m pip install --user pipx 23 pipx install mkdocs-coverage 24 ``` 25 26 ## Usage 27 28 ```yaml 29 # mkdocs.yml 30 nav: 31 - Coverage report: coverage.md 32 33 plugins: 34 - coverage: 35 page_path: coverage # default 36 html_report_dir: htmlcov # default 37 ``` 38 39 The page path can be nested: 40 41 ```yaml 42 # mkdocs.yml 43 nav: 44 - Coverage report: dev/reports/coverage.md 45 46 plugins: 47 - coverage: 48 page_path: dev/reports/coverage 49 ``` 50 51 Now serve your documentation, 52 and go to http://localhost:8000/coverage/ 53 to see your coverage report! 54 55  56 