Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial commit for docs #683

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy Docs

on:
workflow_dispatch:
inputs:
subdir:
type: string
required: false
default: "next"
workflow_call:
inputs:
subdir:
type: string
required: false
default: "next"
jobs:
build-deploy:
permissions:
contents: write
pages: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
- uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Build
run: |
sudo apt install -y \
doxygen \
graphviz \
python3-pip \
python3-setuptools
python3 -m pip install mkdocs mkdocs-github-admonitions-plugin mkdocs-get-deps pymdown-extensions mdx_truly_sane_lists
./dist/make-docs.sh
bun install -g gh-pages
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dist/website
destination_dir: ${{ inputs.subdir }}
12 changes: 12 additions & 0 deletions .github/workflows/push-master.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Docs `next`

on:
push:
branches:
- master
jobs:
docs:
uses: ./.github/workflows/docs.yml
permissions:
contents: write
pages: write
17 changes: 17 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,20 @@ jobs:
uses: softprops/action-gh-release@v2
with:
files: "dist/*.zip"
docs:
uses: ./.github/workflows/docs.yml
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
with:
subdir: ${{github.ref_name}}
permissions:
contents: write
pages: write
docs-latest:
uses: ./.github/workflows/docs.yml
needs: [docs]
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
with:
subdir: latest
permissions:
contents: write
pages: write
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.vscode
.idea
.DS_Store
.bun.lockb

build/
src/bundles/js/
Expand Down
3 changes: 3 additions & 0 deletions dist/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/website/api/
/website/doxygen/
/website/docs/
Loading
Loading