Developer Information

This documentation is hosted in a separate repository from the template itself.

• Template Repository: https://github.com/zhaw-lsfm/quarto-thesis
• Documentation Repository: https://github.com/zhaw-lsfm/quarto-thesis-docs

Why Separate Repositories?

The separation allows:

1. Template testing without Quarto project interference
2. Independent documentation updates
3. Cleaner template installation for students
4. Better CI/CD workflows for each purpose

Template Repository Structure

The template repository (zhaw-lsfm/quarto-thesis) contains:

1. Quarto Extension (_extensions/zhaw-lsfm/) - The actual extension with Typst templates, filters, and shortcodes
2. Book project — Multi-chapter thesis with _quarto.yml configuration and numbered chapter files (index.qmd, 1-einleitung.qmd, …)
3. Book entry point (index.qmd) — Front matter (abstract, TOC, abbreviations) that also serves as the HTML landing page

Students install with:

quarto use template zhaw-lsfm/quarto-thesis

This installs the extension and creates a book project with multiple chapter files, plus supporting files like cover.png and references.bib. Files listed in .quartoignore are NOT provided to students.

Documentation Repository Structure

This repository (zhaw-lsfm/quarto-thesis-docs) contains:

• Full documentation website
• ZHAW requirements and guidelines
• Developer contribution guide
• User manual and tutorials

Contributing to Template

To contribute to the template:

1. Clone the template repository:

   git clone https://github.com/zhaw-lsfm/quarto-thesis.git

2. Make changes to:

   • _extensions/zhaw-lsfm/ for extension functionality
   • Chapter files (1-einleitung.qmd, etc.) for the example content
   • _quarto.yml for project configuration and metadata
   • index.qmd for the front matter / book entry point

3. Test changes:

   # Test book rendering
   quarto render
   
   # Test installation in clean directory
   mkdir ../test-install && cd ../test-install
   quarto use template zhaw-lsfm/quarto-thesis

4. Commit and push or create pull request

5. Publish book to GitHub Pages:

   quarto publish gh-pages

Contributing to Documentation

To contribute to this documentation:

1. Clone this repository:

   git clone https://github.com/zhaw-lsfm/quarto-thesis-docs.git

2. Make changes to relevant .qmd files:

   • index.qmd - Welcome/overview
   • getting-started.qmd - Installation guide
   • manual.qmd - User manual
   • zhaw-requirements.qmd - ZHAW requirements
   • for-devs.qmd - This file

3. Preview locally:

   quarto preview

4. Commit and push or create pull request

5. Publish documentation:

   quarto publish gh-pages

The documentation website is published at: https://zhaw-lsfm.github.io/quarto-thesis-docs

Template Demo

The rendered book is hosted on the template repository’s GitHub Pages:

• HTML Demo: https://zhaw-lsfm.github.io/quarto-thesis/
• PDF Demo: https://zhaw-lsfm.github.io/quarto-thesis/Robuste-Regression-und-Outlier-Erkennung.pdf

These are linked from this documentation site’s navigation menu.