A template for Quarto documents

The files in this repository are provided as a template for working with Quarto (nice formatting of Markdown, HTML, and DocX).

Formatting the documents

Formatting is done using Quarto (https://www.quarto.org/). The formatting format is Markdown (https://daringfireball.net/projects/markdown/).

Setup:

• install Quarto
• verify functionality with quarto check
• if needed, install TeX afterwards, for example with quarto install tinytex

Running quarto render generates the following assets:

Document structure

The master document for Erster-Text is ./Erster-Text/Erster-Text.qmd. It includes the chapters and sections.

Please copy images to ./images/.

Generating a release

• Create a subfolder

• Create the master document meindokument.qmd in that subfolder

• Create sub-documents as in the example

• In ./_quarto.yml, register the master document (tag: render:)

• To generate: run quarto render => Output is in ./output/...

• A release is always generated for all documents in this repository!

• Releases either have a version tag (git tag with v0.17) or the commit ID is shown

• Generating the PDF is always “follow-up,” so the workflow is as follows:

  1. Write the documents
  2. git commit
  3. Render with quarto render
  4. Check the generated documents (they now show the latest commit ID as the version)
  5. git tag v0.18; git push --tags
  6. quarto render (now the documents have the version tag)
  7. git add .; git commit -a -m "Push generated docs for version v0.18"; git push