Skip to content

Commit

Permalink
Docs (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrzejressel authored Mar 10, 2024
1 parent 7030fc4 commit d6f51ec
Show file tree
Hide file tree
Showing 9 changed files with 64 additions and 1 deletion.
48 changes: 48 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
1 change: 1 addition & 0 deletions docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
1 change: 0 additions & 1 deletion docs/.gitignore

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting started
13 changes: 13 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit d6f51ec

Please sign in to comment.