Use MkDocs for a documentation site #460
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
Using Material for MkDocs
CyanVoxel
added
Type: Documentation
|
Thank you so much for this! I'll work on getting this deployed, then the docs can receive some much needed work 👍 |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This is my initial work on using MkDocs and Material for MkDocs for a docs site using the existing docs markdown from this repo.
A demo of the site deployed from my fork is here: https://floogulinc.com/TagStudio/
If this is merged, to enable deployment you will need to set these options in the repo pages settings:
Deploy from a branchgh-pages/ (root)