Skip to content

Commit f8a73f8

Browse files
authored
Update README with ProperDocs references
1 parent 9211ffc commit f8a73f8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
**[Hatch] plugin to integrate [MkDocs] and infer dependencies into an env**
44

55
[![PyPI](https://img.shields.io/pypi/v/hatch-mkdocs)](https://pypi.org/project/hatch-mkdocs/)
6-
[![License](https://img.shields.io/github/license/mkdocs/hatch-mkdocs)](https://github.com/mkdocs/hatch-mkdocs/blob/master/LICENSE.md)
7-
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mkdocs/hatch-mkdocs/ci.yml.svg)](https://github.com/mkdocs/hatch-mkdocs/actions?query=event%3Apush+branch%3Amaster)
6+
[![License](https://img.shields.io/github/license/mkdocs/hatch-mkdocs)](https://github.com/ProperDocs/hatch-properdocs/blob/master/LICENSE.md)
7+
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ProperDocs/hatch-properdocs/ci.yml.svg)](https://github.com/ProperDocs/hatch-properdocs/actions?query=event%3Apush+branch%3Amaster)
88

99
This plugin populates [Hatch] environments with `dependencies` on the fly based on a [`mkdocs.yml`] file.
1010

@@ -69,7 +69,7 @@ gh-deploy = "mkdocs gh-deploy -f mkdocs.yml {args}"
6969

7070
With this:
7171

72-
* You don't need to specify the PyPI dependencies, they get inferred on the fly just from [`mkdocs.yml`] by doing a reverse lookup of MkDocs plugins in the [catalog], using [`mkdocs get-deps`]. (See more details there)
72+
* You don't need to specify the PyPI dependencies, they get inferred on the fly just from [`mkdocs.yml`] by doing a reverse lookup of MkDocs plugins in the [catalog], using [`properdocs get-deps`]. (See more details there)
7373

7474
* An automatically managed virtual environment with pre-defined MkDocs commands is at your fingertips.
7575

@@ -188,8 +188,8 @@ Inside `[envs.ENV_NAME]` (which is an ordinary construct in Hatch) you can proce
188188

189189
[MkDocs]: https://github.com/mkdocs/mkdocs
190190
[`mkdocs.yml`]: https://www.mkdocs.org/user-guide/configuration/
191-
[`mkdocs get-deps`]: https://github.com/mkdocs/get-deps
192-
[catalog]: https://github.com/mkdocs/catalog
191+
[`properdocs get-deps`]: https://github.com/ProperDocs/get-deps
192+
[catalog]: https://github.com/ProperDocs/catalog
193193
[Hatch]: https://hatch.pypa.io/
194194
[install Hatch]: https://hatch.pypa.io/latest/install/#pip
195195
[installing `pipx`]: https://pypa.github.io/pipx/installation/

0 commit comments

Comments
 (0)