testing docs

.github/workflows/mkdocs.yaml

@@ -0,0 +1,50 @@
+name: Deploy MkDocs Site to Pages
+
+on:
+  push:
+    branches: [ "main" ]
+  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
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install mkdocs-material
+
+      - name: Build with MkDocs
+        run: mkdocs build --strict
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

mkdocs-requirements.txt

@@ -0,0 +1 @@
+mkdocs-material==9.5.3

mkdocs.yaml

@@ -0,0 +1,51 @@
+site_name: videobeaux
+site_description: The friendly multilateral video toolkit built for artists by artists.
+site_url: https://schwwaaa.github.io/videobeaux/
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: deep purple
+      accent: amber
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: black
+      accent: amber
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.tabs
+    - navigation.sections
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+  icon:
+    repo: fontawesome/brands/github
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - Effects: effects.md
+  - Utilities: utilities.md
+
+markdown_extensions:
+  - tables
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.emoji
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+repo_url: https://github.com/schwwaaa/videobeaux
+plugins:
+  - search

requirements.txt

@@ -5,7 +5,8 @@ charset-normalizer==3.4.2
 decorator==4.4.2
 idna==3.10
 imageio==2.37.0
-imageio-ffmpeg==0.6.0
+imageio-ffmpeg==0.6.0 
+mkdocs-material==9.5.3
 moviepy==1.0.3
 numpy==2.2.6
 pillow==11.3.0