mirror of https://github.com/ysoftdevs/terraform-aws-eks.git synced 2026-01-13 23:33:59 +01:00

Files

Bryant Biggs 7cd3be3fbb docs: Add mkdocs support to render static documentation site on GitHub (#3070 )

* docs: Add `mkdocs` support to render static documentation site on GitHub

* fix: Correct mis-spelled file name

2024-06-14 09:46:46 -04:00

Local Development

Documentation Site

In order to run the documentation site locally, you will need to have the following installed locally:

Python 3.x
mkdocs
The following pip packages for mkdocs (i.e. - pip install ...)
- mkdocs-material
- mkdocs-include-markdown-plugin
- mkdocs-awesome-pages-plugin

To run the documentation site locally, run the following command from the root of the repository:

mkdocs serve

Opening the documentation at the link posted in the terminal output (i.e. - http://127.0.0.1:8000/terraform-aws-eks/)