Skip to content

geocompx/quarto-book-template

Repository files navigation

geocompx Quarto Book Template

geocompx starter template for Quarto book projects.

Getting started

  1. Update the book metadata in _quarto.yml.
  2. Replace the starter text in the .qmd files with project-specific content.
  3. Add, remove, or rename chapters as needed.
  4. Render locally while editing.
  5. Publish downstream books with GitHub Actions.

An initial GitHub Actions setup is included:

  • .github/workflows/publish.yml.disabled is a starter publish workflow for downstream books. Adapt it to the language-specific dependencies of the downstream book before enabling it.

Rendering

Local output goes to docs/ for preview only and should not be committed. This template repo also ignores _freeze/; downstream book repos can decide whether to commit _freeze/ based on their reproducibility and render-time needs.

quarto preview

PDF output

PDF support is included but commented out in _quarto.yml. Enable it when preparing a publication-ready PDF.

quarto render --to pdf

License

This template is distributed under the MIT license, except for the bundled krantz.cls LaTeX class.

About

geocompx starter template for Quarto book projects

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.krantz

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors