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

Consider using mkdocs material #1806

Closed
1 task done
hypergonial opened this issue Jan 8, 2024 · 3 comments · Fixed by #1810
Closed
1 task done

Consider using mkdocs material #1806

hypergonial opened this issue Jan 8, 2024 · 3 comments · Fixed by #1810
Labels
enhancement New feature or request

Comments

@hypergonial
Copy link
Contributor

Summary

We should consider using mkdocs material for the documentation.

I have the following reasons as to why:

  • Much better search that is very responsive
  • Nicer looking interface
  • The entire site doesn't have to reload for every navigation (Instant Navigation)
  • Highly extensible and customizable
  • Properly builds objects.inv so it is actually usable by other repos
  • Supports advanced markdown features such as tabs & admonishments (full list)
  • Is also supported by readthedocs so documentation versioning & deployment should be simple

Why is this needed?

The current documentation is very slow to load, the search is not very responsive (if it works at all), and objects.inv is almost completely unusable by other documentation generators.

Ideal implementation

Something like this

If given the go-ahead, I'd be willing to work on a PR to switch the documentation to mkdocs-material with a similar configuration as the one I use, linked above.

Checklist

  • I have searched the issue tracker and have made sure it's not a duplicate. If it is a follow up of another issue, I have specified it.
@hypergonial hypergonial added the enhancement New feature or request label Jan 8, 2024
@parafoxia
Copy link
Contributor

I can vouch for MkDocs Material -- I use it myself and it's wonderful.

@hypergonial
Copy link
Contributor Author

I can vouch for MkDocs Material -- I use it myself and it's wonderful.

Way ahead of you already, PR is almost done :p

@parafoxia
Copy link
Contributor

Oh yeah so there is, didn't see that lmao.

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

Successfully merging a pull request may close this issue.

2 participants