Using mkdocs to serve docs from our markdown files #62
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
.github/workflows/docs-deploy.yml
Outdated
| run: mkdocs build --clean | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| uses: peaceiris/actions-gh-pages@v3 |
There was a problem hiding this comment.
Could this be a simpler way to publish:
https://github.com/statisticsnorway/nais-system/blob/main/.github/workflows/publish-gh-pages.yml
There was a problem hiding this comment.
Good suggestion!
| @@ -0,0 +1,53 @@ | |||
| site_name: Microdata-tools | |||
|
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.
Docs!
The docs are available through github pages here: https://statisticsnorway.github.io/microdata-tools/
I'm using mkdocs material theme with some custom css (Just 2 color changes so no worries backend ppl! ) to get closer to the microdata style & theme.
There were some markdown which didn't render correct in the mkdocs (mostly due to extra space or lack of space). So keep an eye out for things I've missed.
The actual pages are rendered from a separate branch which only contains the built docs. The docs should
NB
It uses https://github.com/peaceiris/actions-gh-pages/tree/v3/ a third-party to deploy to gh-pages. ( It seems like a recommended approach) And should be fine for our open-source docs.
Here are some screenshots: