deploy to gh-pages

Author: khuyentran1401

.github/workflows/deploy.yml

@@ -0,0 +1,20 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build

.github/workflows/publish-marimo.yml

@@ -42,24 +42,37 @@ uv run marimo edit notebook.py --sandbox
 
 ### Publishing Notebooks
 
-Add the following workflow to `.github/workflows/publish-marimo.yml`:
-
-```yaml
-...
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      ...
-      - name: Export notebook
-        run: |
-          uv run marimo export html notebook.py -o build/notebook.html --sandbox
-      ...
-```
+To export your marimo notebooks to HTML locally:
+
+1. Make sure the `export_notebook.sh` script is executable:
+
+   ```bash
+   chmod +x export_notebook.sh
+   ```
+
+2. Run the script with your notebook name:
+
+   ```bash
+   # For notebooks in the root directory
+   ./export_notebook.sh notebook_name
+
+   # For notebooks in subdirectories
+   ./export_notebook.sh path/to/notebook_name
+   ```
+
+   For example:
+
+   ```bash
+   ./export_notebook.sh data_science_tools/polars_vs_pandas
+   ./export_notebook.sh llm/pydantic_ai_examples
+   ```
+
+The exported HTML files will be automatically deployed to GitHub Pages through the GitHub Actions workflow.
 
 ## Pull Request Process
 
 1. Fork the repository
 2. Create a new branch for your feature
 3. Make your changes
-4. Submit a pull request with a clear description of changes
+4. Submit a pull request with a clear description of changes
+

contribution.md

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# Check if a notebook name was provided
+if [ -z "$1" ]; then
+    echo "Error: Please provide a notebook name"
+    echo "Usage: ./export_notebook.sh notebook_name"
+    exit 1
+fi
+
+# Get the notebook name without .py extension if provided
+notebook_name=${1%.py}
+
+# Get the directory path
+dir_path=$(dirname "$notebook_name")
+notebook_base=$(basename "$notebook_name")
+
+# Create build directory and subdirectories if they don't exist
+mkdir -p "build/$dir_path"
+
+# Export the notebook to HTML
+echo "Exporting $notebook_name.py to HTML..."
+uv run marimo export html "$notebook_name.py" -o "build/$notebook_name.html" --sandbox
+
+# Check if the export was successful
+if [ $? -eq 0 ]; then
+    echo "Successfully exported $notebook_name.py to build/$notebook_name.html"
+else
+    echo "Error: Failed to export notebook"
+    exit 1
+fi