Skip to content

Commit

Permalink
Add github actions to deploy docs site to gh pages
Browse files Browse the repository at this point in the history
  • Loading branch information
jawadqur committed Dec 2, 2024
1 parent 6c32872 commit e6afc9e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 6 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/docs-ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: docs-ci
on:
push:
branches:
- master
- main
- feat/staging-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 mkdocs-encryptcontent-plugin
- run: cd gen3 && mkdocs gh-deploy --force
16 changes: 10 additions & 6 deletions gen3/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,12 @@ theme:
name: material
features:
- navigation.footer
- navigation.indexes
- navigation.tracking
- navigation.path

custom_dir: overrides

palette:
- primary: black

Expand All @@ -97,10 +102,8 @@ theme:
toggle:
icon: material/eye-outline
name: Switch to light mode
features:
- navigation.indexes
- navigation.tracking
- navigation.path
extra_css:
- stylesheets/extra.css
use_directory_urls: true
markdown_extensions:
- admonition
Expand All @@ -122,8 +125,9 @@ plugins:
blog_toc: true
- mkdocs-video:
is_video: True
extra_css:
- stylesheets/extra.css
- encryptcontent:
password_inventory:
_global: 'gen3'
extra:
social:
- icon: fontawesome/brands/linkedin
Expand Down

0 comments on commit e6afc9e

Please sign in to comment.