Migrate to Mkdocs #345
Migrate to Mkdocs #345
Conversation
| - uses: actions/checkout@v4 | ||
| - name: Configure Git Credentials | ||
| run: | | ||
| git config user.name github-actions[bot] | ||
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com |
There was a problem hiding this comment.
This is probably only needed for private repos?
| - **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Wasted-Audio/hvcc/issues). | ||
|
|
||
| * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Wasted-Audio/hvcc/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a minimal **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
| - If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Wasted-Audio/hvcc/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a minimal **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
|
There was a problem hiding this comment.
my IDE's formatter automatically changed the formatting of the bullet points. I can revert if you care
There was a problem hiding this comment.
Thnx, I always forget which one you are "supposed" to use, as the integrated renderer in my IDE looks good.
Settling this in this migration sounds good to me!
|
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 |
2 participants
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:
