search

Armchair-Heavy-Industries / Xol-Toolhead

Xol Toolhead is the evolution of 'Mantis Xol 2'. Aimed at modularity and quality of life improvements for installation and serviceability. We have left the mantis carriage behind, and thus are now just Xol sans Mantis. Don't worry, it's still a bit ugly. We wouldn't fix that.
Other
434 stars 54 forks source link

Expand docs to MkDocs deployment #18

Open HumbleDeer opened 8 months ago

HumbleDeer commented 8 months ago

Intent

This expands the current docs to be an MkDocs deployment.

Deployment

Deploying this requires enabling GitHub Pages, and activating deployment from a GitHub Actions workflow:

  1. https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site (follow only steps to enable Pages)
  2. Deploy from Action:https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

The deployment will live at https://armchairengineeri.ng/Xol-Toolhead (analogous to https://Armchair-Engineering.githhub.io/Xol-Toolhead).