Closed FalcoSuessgott closed 3 months ago
Sorry for the prolonged response; I will look at this tomorrow! Thanks for the contribution
Apologize for the wait; I have been debating purchasing a domain and standing up documentation for this repo using Docusaurus!
As discussed, this adds mkdocs as renderer, including Github Action pipeline. This will also always generate the latest docs for
terramaids
CLI reference.You should be able to render it locally by running
mkdocs serve
(make sure to havemkdocs
and the deps inrequirements.txt
installed).I believe you would have to go into the Repos Settings -> Pages -> Deploy from Branch "gh-pages", Directory: "/" (root), once the pipeline ran, to enable GH pages.
Once done, the docs should be available under https://rosesecurity.github.io/terramaid/
I suggest, you play around with the
theme
settings inmkdocs.yml
to match your coloring/font scheme :)Let me know if you run into problems
Cheers
ref: