Skip to content

Commit

Permalink
[doc] Add documentation with mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
IceflowRE committed May 14, 2024
1 parent 7caff36 commit af7eb35
Show file tree
Hide file tree
Showing 29 changed files with 1,279 additions and 690 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Deploy Github Pages

on:
push:
branches: ["main", "dev/doc"]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
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
- name: Install Material for MkDocs
run: pip install mkdocs-material mkdocs-minify-plugin pillow cairosvg
- name: Build Website
working-directory: doc/
run: mkdocs build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './doc/site/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@

addons/explore-editor-theme/
archives/
doc/.cache/
doc/site/
Loading

0 comments on commit af7eb35

Please sign in to comment.