-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Show configuration toml files in tabs within the docs #8384
Comments
The same style could be used in other areas within the docs too for example the installation instructions as here in the rye docs - again another project using Material for MkDocs. |
This would be great, especially for showing |
And this from the page you linked suggests maybe what I described implemented in the hugo docs is possible with Material for MkDocs. |
For reference, FastAPI does a lot of this in it's documentation. For example, |
Would love for someone to take this on, great contributor project that doesn't require Rust :) |
I'd like to work on this, please assign me :) |
I would be happy to help too. I'm a bit reluctant to take it all on owing to the pace this project is moving and my time. I wouldn't want to disappoint people. Maybe, if it is a lot of work we could split it between myself and trag1c? |
Hey, to be fair I think I'm almost done if I didn't miss anything, I just need to update the part that generates the Settings section. |
I'm only learning to program (starting with python) so I think I could only meaningfully contribute right now in terms of reporting issues and improving the docs. |
## Summary Closes #8384. ## Test Plan Checked whether it renders properly on the `mkdocs serve` preview.
To better understand what I mean see here and below in the hatch docs which also uses Material for Mkdocs.
It doesn't seem the case in the hatch docs that if you select one such tab that all the tabs that follow automatically select the same tab. I don't know how it is done but that is the case in the hugo docs for example here and below and it is a really nice feature.
I think this would be a great improvement to the
ruff
docs in terms of readability and understanding for users.The text was updated successfully, but these errors were encountered: