MkDocs integration with GitHub Pages #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently set up MkDocs integration with GitHub Pages on a repository of mine: basically I wrote a script to run MkDocs inside GitHub Actions, that automatically generates a proper (static) website that is well-organized, searchable, etc. and uses the Material for MkDocs theme.
So I thought it would be nice to configure KnowledgeBass in a similar way to get the same result. I got something that looks like this:
If you want to give it a try locally before approving this PR, you can download the generated zip file from the Artifacts section of the latest GitHub Actions workflow run (at the moment this one: https://github.com/violinminds/knowledgebass/actions/runs/8590462276). There is only one artifact, named
github-pages.In this PR I'm providing some basic configuration (mostly based on mine), but, if you like this idea, feel free to customize the config files as you wish 🙂
Note: to make this work, we have to set the GitHub Pages source to "GitHub Actions" in the repo settings before merging this PR, like this: