UpCloudLtd / upcloud-cli

UpCloud command line client (upctl)
https://upcloudltd.github.io/upcloud-cli/
MIT License
29 stars 7 forks source link

refactor(docs): generate documentation with Material for MkDocs #188

Closed kangasta closed 1 year ago

kangasta commented 1 year ago

Remove previous Jekyll based GitHub pages and replace those with MkDocs based solution that uses Material for MkDocs theme with few custom overrides. Remove generated documentation from main branch.

In addition, add custom logic for markdown command reference generation in order to:

kangasta commented 1 year ago

To test the docs output:

git fetch
git checkout gh-pages
python3 -m http.server 8000 # or any other command that starts static HTTP server

or checkout this branch, run make docs and mkdocs serve.


TODO After merge:

kangasta commented 1 year ago

Good catch! I'll update Documentation section in README before merging this