WIP: ENH: Myst-MD refactor

Author: thewtex

.github/workflows/build-myst.yml

@@ -0,0 +1,100 @@
+name: Build MyST Document
+
+on:
+  push:
+    branches: [ main, myst ]
+  pull_request:
+    branches: [ main, myst ]
+  workflow_dispatch:
+
+jobs:
+  build-myst:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      
+    - name: Setup Pixi
+      uses: prefix-dev/[email protected]
+      with:
+        pixi-version: latest
+        
+    - name: Install dependencies
+      run: pixi install
+      
+    - name: Build HTML
+      run: pixi run build-html
+      
+    - name: Build PDF
+      run: pixi run build-pdf
+      
+    - name: Build all formats
+      run: pixi run build-complete
+      
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: myst-outputs
+        path: |
+          _build/
+          exports/
+        retention-days: 30
+
+  build-source:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      
+    - name: Setup Pixi
+      uses: prefix-dev/[email protected]
+      with:
+        pixi-version: latest
+        
+    - name: Install dependencies
+      run: pixi install
+      
+    - name: Build source code
+      run: pixi run build-src
+      
+    - name: Run tests
+      run: pixi run test-src
+      
+    - name: Upload test results
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: test-results
+        path: |
+          build/Testing/
+        retention-days: 30
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: [build-myst, build-source]
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/myst'
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      
+    - name: Setup Pixi
+      uses: prefix-dev/[email protected]
+      with:
+        pixi-version: latest
+        
+    - name: Install dependencies
+      run: pixi install
+      
+    - name: Build for deployment
+      run: pixi run build-complete
+      
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./_build/html
+        cname: insight-journal-template.readthedocs.io

.gitignore

@@ -1,3 +1,4 @@
+# LaTeX build artifacts
 *.aux
 *.bbl
 *.blg
@@ -9,3 +10,46 @@
 *.ps
 *.toc
 _minted-*/
+
+# MyST Markdown build outputs
+_build/
+site/
+.myst/
+*.epub
+*.meca
+
+# Pixi environment and cache
+.pixi/
+pixi.lock
+__pycache__/
+*.pyc
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Build directories
+build/
+dist/
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+Makefile
+
+# Node.js (if using MyST plugins)
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Python virtual environments
+venv/
+env/
+.env

Document/LaTeX/InsightJournal.sty

@@ -1111,7 +1111,7 @@
 \url{http://hdl.handle.net/10380/#1}}  
 
 \newcommand{\IJhandle}[1]{
-Latest version available at the \href{http://www.insight-journal.org}{Insight Journal} [\urlhandle{#1}]\\
+Latest version available at the \href{http://insight-journal.org}{Insight Journal} [\urlhandle{#1}]\\
 Distributed under \href{http://creativecommons.org/licenses/by/3.0/us/}{Creative Commons Attribution License}}
 
 \newcommand{\IJhandlefooter}[1]{

Document/MS-Word/ArticleExample.doc

@@ -1,7 +1,7 @@
 This repository contains a template for submitting
 Technical Reports to the Insight Journal:
 
-         http://www.insight-journal.org
+         http://insight-journal.org
 
 All source code in this repository is distributed
 under the Apache 2.0 License

NOTICE

@@ -1,15 +1,44 @@
-Insight Journal Template
-========================
+Insight Journal MyST Template
+===============================
 
-[![Build LaTeX document](https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/actions/workflows/build-test-latex.yml/badge.svg?branch=master)](https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/actions/workflows/build-test-latex.yml)
+[![Build MyST Document](https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/actions/workflows/build-myst.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/actions/workflows/build-myst.yml)
 
-This repository contains a template for submitting Technical Reports to the
-Insight Journal:
+This repository contains a modern template for submitting Technical Reports to the
+Insight Journal using MyST Markdown:
 
-    http://www.insight-journal.org
+    https://insight-journal.org
 
+## Overview
 
-Overleaf Link: https://www.overleaf.com/latex/templates/insight-journal/grjrhxkzzsvf
+This template has been transformed from LaTeX to **MyST Markdown**, providing:
+
+- 🚀 **Modern authoring** with MyST Markdown
+- 📦 **Dependency management** with Pixi
+- 🔄 **Reproducible builds** and environments
+- 📄 **Multiple export formats** (PDF, HTML, DOCX, MECA)
+- 🧪 **Integrated source code** testing and validation
+- 📚 **Rich scientific features** (equations, citations, cross-references)
+
+## Quick Start
+
+See the complete documentation in [`doc/README.md`](doc/README.md).
+
+### With Pixi (Recommended)
+
+1. Install [Pixi](https://pixi.sh/latest/)
+2. Clone and build:
+   ```bash
+   git clone https://github.com/InsightSoftwareConsortium/InsightJournalTemplate.git
+   cd InsightJournalTemplate
+   pixi install
+   pixi run build-complete
+   ```
+
+### Legacy LaTeX Template
+
+The original LaTeX template is still available in the `Document/` directory.
+
+**Overleaf Link**: https://www.overleaf.com/latex/templates/insight-journal/grjrhxkzzsvf
 
 
 License