Add social previews (#40)

Author: VeckoTheGecko

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.github/workflows/ci.yml

@@ -1,17 +1,19 @@
 name: CI
 on:
+    push:
+        branches:
+            - "main"
     pull_request:
 
 jobs:
     build:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v4
-            - uses: actions/checkout@v4
-            - uses: astral-sh/setup-uv@v4
+            - uses: prefix-dev/setup-pixi@v0.9.3
               with:
-                  version: "latest"
-            - run: uv run mkdocs build
+                  pixi-version: latest
+            - run: pixi run mkdocs build
             - uses: actions/upload-artifact@v4
               with:
                   name: Website

.github/workflows/gh-pages.yml

@@ -17,15 +17,14 @@ jobs:
               run: |
                   git config user.name github-actions[bot]
                   git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-            - uses: actions/checkout@v4
-            - uses: astral-sh/setup-uv@v4
+            - uses: prefix-dev/setup-pixi@v0.9.3
               with:
-                  version: "latest"
+                  pixi-version: latest
             - 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: uv run mkdocs gh-deploy --force
+            - run: pixi run mkdocs gh-deploy --force

.gitignore

@@ -2,3 +2,7 @@
 !docs/talks/assets
 __pycache__
 .DS_Store
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+.cache

README.md

@@ -9,7 +9,7 @@
 This website codebase uses `uv` and `mkdocs`. To get started (assuming you have `uv` installed):
 
 - clone this repo and `cd` into it
-- run `uv run python -m mkdocs serve` to set up the environment and run the development server
+- run `pixi run mkdocs serve` to set up the environment and run the development server
 
 This project also uses `pre-commit` which you can optionally run locally (though not required as it's run in the cloud anyway).
 

mkdocs.yml

@@ -30,6 +30,7 @@ nav:
     - calendar.md
     - code-of-conduct.md
 plugins:
+    - social
     - macros
     - mkdocs-jupyter:
           ignore_h1_titles: True

pixi.lock

@@ -0,0 +1,19 @@
+[workspace]
+name = "CLAM"
+version = "0.1.0"
+description = "CLAM Website"
+channels = ["conda-forge"]
+platforms = ["linux-64", "osx-64", "osx-arm64", "win-64"]
+
+[dependencies]
+python = ">=3.10"
+mkdocs = ">=1.6.1"
+pydantic = ">=2.12.1"
+pyyaml = ">=6.0.1"
+
+# mkdocs
+mkdocs-material = ">=9.5.50"
+mkdocs-macros-plugin = ">=1.3.7"
+mkdocs-jupyter = ">=0.25.1"
+pillow = "*"
+cairosvg = "*"

pixi.toml

@@ -1,18 +1,3 @@
-[project]
-name = "CLAM"
-version = "0.1.0"
-description = "CLAM Website"
-readme = "README.md"
-requires-python = ">=3.10"
-dependencies = [
-    "mkdocs-macros-plugin>=1.3.7",
-    "mkdocs>=1.6.1",
-    "mkdocs-jupyter>=0.25.1",
-    "mkdocs-material>=9.5.50",
-    "pydantic>=2.12.1",
-    "pyyaml>=6.0.1",
-]
-
 [tool.ruff]
 select = [
     "D",  # pydocstyle