How This Site is Built and Structured
🏗️ Architecture
This site follows a multi-repository architecture designed for scalability and maintainability:
📦 Main Repository (Franklin.jl based)
├── 📖 Study Guides & Documentation
├── 🎨 Responsive Lanyon Template Variant
└── 🔗 Integration Layer
📦 Sub-repositories (DrWatson.jl) based
├── 🔬 Individual Study Projects
├── 📊 Documenter.jl API Documentation
└── 🔄 Reproducible WorkflowsKey Components:
Main Repository: Contains this Franklin.jl site with guides and navigation
Sub-repositories: Individual DrWatson.jl projects with Documenter.jl documentation
Unified Deployment: All documentation accessible through a single domain using GitHub Pages
🛠️ Technical Stack
| Component | Technology | Purpose |
|---|---|---|
| Static Site Generator | Franklin.jl | Fast, Julia-native site generation with math support |
| Template | Lanyon | Responsive, mobile-first design |
| Documentation | Documenter.jl | Project-specific API documentation |
| Project Management | DrWatson.jl | Reproducible scientific projects |
| Deployment | GitHub Actions + Pages | Automated builds and free hosting |
| Styling | Custom CSS + Lanyon | Responsive framework with custom enhancements |
💡 Tip: Start with the Comprehensive Franklin and GitHub Pages Guide to get hands-on experience with the entire workflow!
CC BY-NC-SA 4.00 Aron Trauring. Last modified: July 23, 2025.
Website built with Lanyon, the Github Pages
Website built with Lanyon, the Github Pages