From d6f51ec98a3b7009ef093529735d3fd54da67f88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=8BAndrzej=20Ressel?= Date: Sun, 10 Mar 2024 21:34:01 +0100 Subject: [PATCH] Docs (#25) --- .github/workflows/docs.yml | 48 +++++++++++++++++++ docs.ps1 | 1 + docs.sh | 1 + docs/.gitignore | 1 - .../{pulumi-wasm => Internal}/Data passing.md | 0 docs/{pulumi-wasm => Internal}/Output.md | 0 .../Serialization formats.md | 0 docs/index.md | 1 + mkdocs.yml | 13 +++++ 9 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml create mode 100644 docs.ps1 create mode 100755 docs.sh delete mode 100644 docs/.gitignore rename docs/{pulumi-wasm => Internal}/Data passing.md (100%) rename docs/{pulumi-wasm => Internal}/Output.md (100%) rename docs/{pulumi-wasm => Internal}/Serialization formats.md (100%) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..38f9b02a9 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,48 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Docs + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main", "docs"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: pip install mkdocs-material==9.5.13 + - run: mkdocs build + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'site' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs.ps1 b/docs.ps1 new file mode 100644 index 000000000..37c2c9330 --- /dev/null +++ b/docs.ps1 @@ -0,0 +1 @@ +docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material \ No newline at end of file diff --git a/docs.sh b/docs.sh new file mode 100755 index 000000000..37c2c9330 --- /dev/null +++ b/docs.sh @@ -0,0 +1 @@ +docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 0c5b2bed5..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/.obsidian diff --git a/docs/pulumi-wasm/Data passing.md b/docs/Internal/Data passing.md similarity index 100% rename from docs/pulumi-wasm/Data passing.md rename to docs/Internal/Data passing.md diff --git a/docs/pulumi-wasm/Output.md b/docs/Internal/Output.md similarity index 100% rename from docs/pulumi-wasm/Output.md rename to docs/Internal/Output.md diff --git a/docs/pulumi-wasm/Serialization formats.md b/docs/Internal/Serialization formats.md similarity index 100% rename from docs/pulumi-wasm/Serialization formats.md rename to docs/Internal/Serialization formats.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..3d7219c52 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Getting started \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..6bf71be4f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,13 @@ +site_name: Pulumi WASM +theme: + palette: + scheme: slate + name: material + search: true + +markdown_extensions: + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format \ No newline at end of file