-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Using mkdocs to serve docs from our markdown files #62
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good and simple to navigate files 💯 Added suggestion for simpler deploy ✨
.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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good suggestion!
@@ -0,0 +1,53 @@ | |||
site_name: Microdata-tools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's try 💯
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: