How karbartolome/workshops works
Project Type and Purpose
• This is a static site / slide deck project built with Quarto, incorporating Jupyter notebooks and custom extensions.
• Its purpose is to author and publish interactive workshop slides (HTML) using .qmd and .ipynb sources, plus custom CSS/SASS and an extension for FontAwesome.
File Structure
• Top-level items
• README.md – project overview & setup instructions
• .gitignore – Git config
• 20240513-uba-calibracion/ – Quarto project directory
• testing/ – sandbox examples
• Inside the Quarto folder
• slides.qmd – primary Quarto markdown for slides
• ejemplo.ipynb – supplemental Jupyter notebook
• functions.py & df_german_credit.csv – Python code & data used in code chunks
• custom.scss – styling overrides
• slides.html – generated output
• requirements.txt – Python dependencies
README
• Describes the workshop title, link to published slides, and Conda/Jupyter kernel setup.
Main Components & Their Relationships
• Authoring Environment
• Developer’s IDE (VS Code / JupyterLab)
• Conda environment (quarto-env) with Python, Jupyter, Quarto CLI
• Source Artifacts
• .qmd files (slides.qmd, testing-stuff.qmd)
• .ipynb notebooks (ejemplo.ipynb)
• Python modules & data (functions.py, df_german_credit.csv)
• Custom assets (custom.scss, FontAwesome extension)
• Build System
• Quarto CLI (core)
• Pandoc under the hood
• Extension loader (fontawesome)
• Output
• slides.html (static HTML slide deck)
• ancillary assets (CSS, webfonts)
• Hosting/Publishing
• GitHub Pages (via karbartolome.github.io/workshops)
Architectural Patterns & Principles
• Separation of concerns:
• Content (QMD / IPYNB)
• Style (custom.scss, extension CSS)
• Code & data (functions.py, CSV)
• Plugin architecture: Quarto extensions loaded from _extensions
• Static-site generator pipeline: transform → render → publish
Putting It All Together
• Below, group Source Files (QMD, IPYNB, Python, CSV, custom.scss, extension).
• To the right of the build engine, show the Generated HTML + Asset Bundle.
• A small side-branch to represent the testing/ folder feeding into a parallel “Experimental Slides” build.