Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 refactor docs generation #40

Merged
merged 3 commits into from
Dec 9, 2023
Merged

📝 refactor docs generation #40

merged 3 commits into from
Dec 9, 2023

Conversation

oprypin
Copy link
Contributor

@oprypin oprypin commented Dec 9, 2023

📝 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

📝 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

After:

after

Copy link
Owner

@juftin juftin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 nice, these are sweet improvements - thank you for the thoughtfulness. I will get these changes into my other projects too.

@juftin juftin merged commit f7d9dad into juftin:main Dec 9, 2023
1 check passed
@oprypin oprypin deleted the docsr branch December 9, 2023 15:34
@juftin
Copy link
Owner

juftin commented Dec 15, 2023

🎉 This PR is included in version 1.8.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants