docs: rewrite with mkdocs and add search #363
Open
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.
Closes #235
Demo: https://hay-kot.github.io/sprig/
Highlights
This PR rewrites the current documentation site from jekyll to Mkdocs with the Material theme. With that comes built in search.
I did not implement this with the existing Jekyll theme because
The major downside is that you have to use python to run the development server locally, however it's a small trade-off for what you get (IMO)
the Material theme also offers a lot of customizable elements for enhancing the documentation in the future if desired. See the link below for some examples
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
I'm just using the default theme for now, but I can change the colors to match the existing slate theme if desired. I mostly wanted to get this out there to see if there was any interest in this change