RoseSecurity / Terramaid

A utility for generating Mermaid diagrams from Terraform configurations
Apache License 2.0
280 stars 8 forks source link

feat(mkdocs): add mkdocs as documentation renderer #36

Closed FalcoSuessgott closed 3 months ago

FalcoSuessgott commented 3 months ago

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 have mkdocs and the deps in requirements.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 in mkdocs.yml to match your coloring/font scheme :)

Let me know if you run into problems

Cheers

ref:

RoseSecurity commented 3 months ago

Sorry for the prolonged response; I will look at this tomorrow! Thanks for the contribution

RoseSecurity commented 3 months ago

Apologize for the wait; I have been debating purchasing a domain and standing up documentation for this repo using Docusaurus!