touying-quick

A quick-start slide template based on touying for academic reports.

Get Started

Import touying-quick from the @preview namespace.

#import "@preview/touying-quick:0.4.2": *
#show: touying-quick.with(
  title: "",
  subtitle: "",
  // heading-idx: true,
  // bgimg: bgsky,
  // theme: "blue",
  // info: default-info,
  // styles: default-styles,
  // names: default-names,
  // logo: emoji.bookmark,
  // supplement: [],
  // lang: "en",
  // doc,
)

Tweaking the Params

Heading Index

heading-idx controls whether set heading-numbering.

Background Image

bgimg provides with 3 options: bgsky, bghexagon and bgbook, if they are not your flavor, you may set it to your image path.

Infomation

The info is a toml file that like this

[example]
    footer = "Clayton University"
    header = ""
    lang = "en"
    author = "ivaquero"
    series = "Typst for Academic Reports"
    institution = "School of Artificial Intelligence"
    ending = "Thanks for Your Attention"

Styles

If you are not satisfied with the default styles such as font-family, font-size, you can create a toml like

[fonts.en]
    title = "Palatino"
    author = "Times New Roman"
    footer = "Georgia"
    contents = "Georgia"
    context = "Georgia"
    math = "Times New Roman"
    ending = "Palatino"

[sizes]
    author = 14
    title = 40
    context = 10.5
    footer = 10
    ending = 50

[spaces]
    par-indent = 2
    par-leading = 1
    par-spacing = 1
    list-indent = 1.2
    block-above = 1
    block-below = 1
    contents-indent = 2

after reading this file by toml(), assign its value to the styles argument in function touying-quick().

Names

touying-quick's section names support English and Chinese by default. If you are not neither English speaker nor Chinese speaker, assume you are a French speaker, you can create a toml, for example names.toml, like

[sections.fr]
    outline = "Contents"

[blocks.fr]
    algorithm = "Algorithme"
    table = "Tableau"
    figure = "Figure"
    equation = " Eq."
    rule = "Règle"
    law = "Loi"

after reading this file by toml(), assign its value to the argument names in function touying-quick().

Don't forget to change the key lang in your info toml metioned above.

Supplementary Contents

When the argument supplement is not empty, the supplementary contents will be displayed after the ending slide. A handy usage is include your supplements in it, for example

#show: touying-quick.with(
  ...,
  supplement: [
    #include("supplementary-content-1.typ")
    #include("supplementary-content-2.typ")
  ],
)

Clone the Repository

Clone the touying-quick repository to your @local workspace:

• Linux：
  • $XDG_DATA_HOME/typst/packages/local
  • ~/.local/share/typst/packages/local
• macOS：~/Library/Application\ Support/typst/packages/local
• Windows：%APPDATA%/typst/packages/local

Import touying-quick in the document

#import "@local/touying-quick:0.1.0": *

For developement convinience, local repo never changes the version

Credits

Thanks @OrangeX4 for his touying framework as well as his theorion package.

Also thanks the creators of the following packages

• @Dherse: codly