diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 0000000..918601d --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,41 @@ +name: Publish docs via GitHub Pages +on: + workflow_dispatch: + push: + branches: + - main + - master + +permissions: + contents: read + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Checkout main + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.x + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install mkdocs-material==9.5.26 \ + mkdocs-include-markdown-plugin==6.2.0 \ + mkdocs-awesome-pages-plugin==2.9.2 + + - name: git config + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + + - run: mkdocs gh-deploy --force diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000..ee23da4 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,3 @@ +nav: + - Overview: index.md + - Local Develpment: local.md diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..cdfb9fc Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/assets/terraform-aws.png b/docs/assets/terraform-aws.png new file mode 100644 index 0000000..0697464 Binary files /dev/null and b/docs/assets/terraform-aws.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..31af4c6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Terraform AWS EKS module + +Moar content coming soon! diff --git a/docs/local.md b/docs/local.md new file mode 100644 index 0000000..b50caf7 --- /dev/null +++ b/docs/local.md @@ -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/)) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..cc20c60 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,65 @@ +site_name: Terraform AWS EKS +docs_dir: docs/ +site_url: https://terraform-aws-modules/terraform-aws-eks/ +repo_name: terraform-aws-eks +repo_url: https://github.com/terraform-aws-modules/terraform-aws-eks + +theme: + name: material + logo: assets/terraform-aws.png + favicon: assets/logo.png + font: + text: ember + palette: + primary: deep purple + accent: indgo + icon: + repo: fontawesome/brands/github + admonition: + note: octicons/tag-16 + abstract: octicons/checklist-16 + info: octicons/info-16 + tip: octicons/squirrel-16 + success: octicons/check-16 + question: octicons/question-16 + warning: octicons/alert-16 + failure: octicons/x-circle-16 + danger: octicons/zap-16 + bug: octicons/bug-16 + example: octicons/beaker-16 + quote: octicons/quote-16 + features: + - navigation.tabs.sticky + highlightjs: true + hljs_languages: + - yaml + - json + +plugins: + - include-markdown + - search: + lang: + - en + - awesome-pages + +extra: + version: + provider: mike + +markdown_extensions: + - attr_list + - admonition + - codehilite + - footnotes + - md_in_html + - pymdownx.critic + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - toc: + permalink: true