Migrate GitHub Pages site to Material for MkDocs

alan-turing-institute / trustchain

Trustworthy decentralised PKI

https://alan-turing-institute.github.io/trustchain/

Apache License 2.0

11 stars 5 forks source link

Migrate GitHub Pages site to Material for MkDocs #173

Closed thobson88 closed 4 weeks ago

thobson88 commented 7 months ago

Started on branch mkdocs.

Instructions here: https://squidfunk.github.io/mkdocs-material/getting-started/

once installed, serve locally by first activating the right Python environment and then mkdocs serve.

TODO:

[ ] Add a friendly (non-techie) video of the mobile app demo to the intro page

thobson88 commented 4 months ago

This is ready to deploy. I've added a CI workflow as per these instructions.

PR here: https://github.com/alan-turing-institute/trustchain/pull/186

thobson88 commented 4 months ago

Deployment didn't work (with the theme correctly displayed) until I followed this advice.

In particular, this bit in repo > Settings > Pages:

thobson88 commented 4 months ago

With the settings above, I'm not sure whether the CI for docs deployment is working. I doubt it because I'm using the alternative "manual" deployment method with the built site landing on the gh-pages branch.

In that case, to update the deployed site it's just:

mkdocs gh-deploy --force

UPDATE: turns out the CI does work. Changes pushed/merged to main appear automatically on the deployed site (after a minute or so).

thobson88 commented 4 weeks ago

Closing this and opening a new ticket for the demo video idea.