Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrzejressel committed Mar 10, 2024
1 parent 7030fc4 commit b6004a7
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: ci
on:
push:
branches:
- master
- main
- docs
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
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 b6004a7

Please sign in to comment.