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
This commit is contained in:
Bryant Biggs
2024-06-14 09:46:46 -04:00
committed by GitHub
parent 323fb759d7
commit 7cd3be3fbb
7 changed files with 132 additions and 0 deletions

3
docs/.pages Normal file
View File

@@ -0,0 +1,3 @@
nav:
- Overview: index.md
- Local Develpment: local.md

BIN
docs/assets/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

3
docs/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Terraform AWS EKS module
Moar content coming soon!

20
docs/local.md Normal file
View File

@@ -0,0 +1,20 @@
# Local Development
## Documentation Site
In order to run the documentation site locally, you will need to have the following installed locally:
- [Python 3.x](https://www.python.org/downloads/)
- [mkdocs](https://www.mkdocs.org/user-guide/installation/)
- 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:
```bash
mkdocs serve
```
Opening the documentation at the link posted in the terminal output (i.e. - [http://127.0.0.1:8000/terraform-aws-eks/](http://127.0.0.1:8000/terraform-aws-eks/))