juftin / hatch-pip-compile

hatch plugin to use pip-compile (or uv) to manage project dependencies and lockfiles
http://juftin.com/hatch-pip-compile/
MIT License
74 stars 3 forks source link

📝 refactor docs generation #40

Closed oprypin closed 9 months ago

oprypin commented 9 months ago

📝 switch to a Markdown extension that displays better on GitHub

No change in MkDocs, however on Github: !!! note "pre-commit" Hatch will attempt to set up pre-commit hooks for you using [pre-commit]. If you don't already, make sure to install pre-commit as well: `pipx install pre-commit` > NOTE: **pre-commit** > > Hatch will attempt to set up pre-commit hooks for you using > [pre-commit]. If you don't already, > make sure to install pre-commit as well: `pipx install pre-commit` [pre-commit]: https://pre-commit.com/

📝 deduplicate source of README.md/index.md

Copy the file dynamically but exclude parts that are between two exact <!--skip--> lines.

📝 simplify and unnest nav generation

Before: ![before](https://github.com/juftin/hatch-pip-compile/assets/371383/dc1c0aa0-e9bd-4971-ab75-9e850aa3f1e3)
After: ![after](https://github.com/juftin/hatch-pip-compile/assets/371383/5035c3d9-290b-4ead-bce0-9cec5f016582)
juftin commented 8 months ago

:tada: This PR is included in version 1.8.2 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: