Move documentation to mkdocs
#203
Merged
Conversation
This file contains hidden or 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
This commit only replaces the build process - content changes for mkdocs' markdown will come later
This was only necessary for the virtual competition
There isn't one
WillB97
approved these changes
Jun 24, 2023
Contributor
WillB97
left a comment
WillB97
left a comment
There was a problem hiding this comment.
Theme looks fine, lets get this merged so we can start updating the content.
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.
We currently use Hugo for our documentation, but the theme we use is no longer supported.
Instead, I've ported to
mkdocs, which arguably looks nicer, is incredibly well supported, and is all Python, which is easier for us to work with.This PR adds the basics, does a little cleanup, and removes everything Hugo. There are content changes which need making based on the content here, but that's out of scope for this PR. I've removed entire defunct sections, but not gone much further than that, so we can review the content as a whole in time.
Note this PR merges into
sp2023, which will serve as a feature branch for this year's Smallpeice.