Skip to content

Commit f7bebf6

Browse files
committed
Add docs
1 parent 9ed6be7 commit f7bebf6

File tree

172 files changed

+17176
-47699
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+17176
-47699
lines changed

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- gh-pages
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Set up Python
24+
uses: actions/setup-python@v5
25+
with:
26+
python-version: '3.12'
27+
28+
- name: Install dependencies
29+
run: |
30+
pip install mkdocs-material mkdocs-mermaid2-plugin
31+
32+
- name: Deploy to GitHub Pages
33+
run: |
34+
mkdocs gh-deploy --force

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ repos:
2323
- id: end-of-file-fixer
2424
- id: check-yaml
2525
args: [--allow-multiple-documents]
26+
exclude: ^mkdocs\.yml$
2627
- id: check-toml
2728
- id: check-json
2829
- id: check-added-large-files

CHANGELOG.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)