-
-
Notifications
You must be signed in to change notification settings - Fork 40
Migrate to Mkdocs #345
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
Migrate to Mkdocs #345
Conversation
|
Hey thanks a lot! I've been thinking about how we could add better docs hosting. Adding ToC, dark/light and versioned docs are all super nice and exactly what we need! :) I'll need to try these builds locally (also something I was never able to reproduce with jekyll) first to be able to get into review. |
|
First off: do you mind changing the deleted files into renames in the history? :) |
After installing dependencies, |
Uh, how do you mean? It there a git command? |
|
This way file history stays intact instead of recreating the files. Somehow it happened only on these two files as far as I can see. |
|
We should cleanup Also we can add the |
Sorry, I can't figure out how to cleanly do this without messing up the commits 😭 |
|
It's ok, there were not that many changes on these files anyway :) |
The current theme doesn't provide a table of contents, search or versioning for the docs. Mkdocs provides this for us. This PR migrates to Mkdocs, and hopefuly, the set up is correct for deploying to GitHub pages. In a follow up PR, I'll add support for versioned docs
This is what it looks like:
