README - plain_typst

Skip to article frontmatter Skip to article content

This is the README file for the example book illustrating the usage of the MyST template plain_typst_book. It is located in subdirectory example/. This README is not included in the PDF export of the template, which uses Typst.

Here we do not define an export in the myst.yml file but make use of the following option in the myst.yml file:

extends:
  - export.yml

In the export.yml file we include the export, including optional settings allowed for the template.yml file:

export.yml

version: 1
project:

  plugins:
    - https://github.com/TUD-JB-Templates/JB2_plugins/releases/download/exercise/pdf_exercise.mjs

  downloads:
    - id: output-pdf

  exports:
    - id: output-pdf
      format: typst
      template: ../
      output: ./exports/plain_typst_book.pdf
# additional options #

# Include a figure at the cover page
      cover: Cover.PNG
      coverposition: 5  #in cm from title
      cover_width: 8 #in cm

# ToC
      ToC_depth: 2
      show_ToC: true

# Page settings
      #### Logo at top of position
      logo: logo.svg
      logo_width: 10

      #### Looks
      papersize: a4
      margin_top: 2 #cm
      margin_bottom: 2 #cm
      margin_left: 10 #%
      margin_right: 10 #%
      show_pagenumber: true

      #### Fonts
      fontsize: 12
      fontstyle: 
      linespacing: .5
      justification: false
      
      #### Theme
      colortheme: blue.darken(30%)
      colorheadings: navy
      
# Preface
      preface: This is a test for the plain_typst_book template. As example, we include a part of a chapter of a JB2 book used at Delft, University of Technology.

plain_typst_book

Chapter 1