Merge pull request #4 from OSIPI/add-mkdocs-deploy-workflow

Add github deployment workflow.

Author: ltorres6

.github/workflows/deploy.yml

@@ -0,0 +1,37 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

docs/index.md

@@ -1,5 +1,16 @@
-# Task Force 2.2: ASL Functionalities-Test Report
+# OSIPI ASL Toolbox
 
-Welcome to the documentation for the ASL Toolbox.  
+A curated library of open-source functions for Arterial Spin Labeling (ASL) perfusion MRI preprocessing and analysis, developed by [OSIPI Task Force 2.2](https://osipi.org/).
 
-This documentation is generated from [ASL_functionalities_test_report_Github.docx](https://github.com/OSIPI/TF2.2_OSIPI-ASL-toolbox/blob/main/ASL_functionalities_test_report_Github.docx)
+## Contributing Toolboxes
+
+- **ASLtbx & DL-ASL** — University of Maryland
+- **ASL-MRICloud** — Johns Hopkins University
+- **BASIL & Oxford-ASL** — University of Oxford / Nottingham
+- **ExploreASL** — [exploreASL.org](https://www.exploreasl.org/)
+- **DeepASL** — Technical University of Munich
+- **Preclinical ASL** — Multi-site contributions
+
+## Documentation
+
+Browse the sidebar for function documentation organized by processing step, from [motion correction](motion_correction.md) through [CBF quantification](cbf_quantification.md) to [deep learning denoising](deep_learning.md).

mkdocs.yml

@@ -1,6 +1,6 @@
 # Project information
 site_name: TF2.2_OSIPI-ASL-toolbox
-site_url: https://github.com/OSIPI/TF2.2_OSIPI-ASL-toolbox
+site_url: https://osipi.github.io/TF2.2_OSIPI-ASL-toolbox/
 site_author: OSIPI
 site_description: >-
   OSIPI aims to develop resources and best practices for the analysis of perfusion imaging data and interoperability of the analysis results.

requirements.txt

@@ -2,4 +2,5 @@ mkdocs
 mkdocs-multirepo-plugin
 mkdocs-material
 mkdocs-material-extensions
-mkdocs-minify-plugin
+mkdocs-minify-plugin
+Pygments