Skip to content

hei-templates/hei-typst-thesis

Repository files navigation

HEI Logo Logo HEI Logo Logo
HEI-Vs Engineering School - Typst Thesis Template

A Typst template for the HES-SO//Valais Wallis Bachelor thesis.

Warning Disclaimer, this is an unofficial typst template not supported by the HEI-Vs. Use at your own risk, no support is provided for installation or use. You have been warned.

Table of contents

FeaturesGetting startedContributingCreditsFind us on

Typst Logo

Features

(Back to top)

  • Title page with official layout
  • Table of contents, Table of figures, Table of tables, Table of listings, Table of equations
  • Abstract
  • Nice title styles for chapter and appendices
  • Chapter table of contents (minitoc)
  • Acronyms
  • Glossary
  • Bibliography
  • Code highlighting
  • Nice default typography settings
  • Custom Boxes
  • Word Counters

Getting started

(Back to top)

Installation

This document is made for typst v0.12.0.

MacOS

# [homebrew](https://brew.sh)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/
install.sh)"

# [just](https://just.systems)
brew install just

# [typst](https://github.com/typst/typst)
brew install typst

Linux & MacOS (via Rust)

# [rust](https://www.rust-lang.org/tools/install)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# [just](https://just.systems)
cargo install just

# [typst](https://github.com/typst/typst)
cargo install typst

Windows

Open a Windows Powershell as Administrator

# [chocolatey](https://chocolatey.org)
# ensure to use a administrative powershell
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

Open a new Windows Powershell as Administrator

# [just](https://just.systems)
choco install just

# [typst](https://github.com/typst/typst)
choco install typst

# [vscode](https://code.visualstudio.com/)
choco install vscode vscli

# [git](https://git-scm.com/downloads)
choco install git.install

How to use

  1. Read the Guide to Thesis and Guide to Typst

  2. Modify variables in 01-settings/metadata.typ

  3. Write your thesis there are plugins for Zed, VS-Code and Sublimetext available

  4. Use the given justfile or typst directly to build the PDF

    With the justfile

    just
    Available recipes:
     clean                      # cleanup intermediate files
     default                    # List all commands
     info                       # Information about the environment
     install                    # install required sw
     open file_name=doc_name    # open pdf
     pdf file_name=doc_name     # build, rename and copy a typ file to a pdf
     pdf-all file_name=doc_name # build, rename and copy a typ file in all variants
     watch file_name=doc_name   # watch a typ file for continuous incremental build

    With typst directly

    typst c main.typ             # compiles thesis to main.pdf
    typst w main.typ             # watches all documents and incrementally compiles to main.pdf

Contributing

(Back to top)

  1. Take a look at the issues issues with the "Help wanted" tag
  2. Choose something or open a new issue
  3. Fork the repo, fix the problem in a branch
  4. Rebase your branch if needed
  5. Submit a pull request

Help

(Back to top)

Read Guide to Typst Download Guide to Typst

Read Guide to Thesis Download Guide to Thesis

Credits

(Back to top)

Find us on

(Back to top)

About

HEI-VS Typst Template with Examples for Thesis

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published