TomVer99 / FHICT-typst-template

A Typst template for FHICT to create professional looking documents with ease

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FHICT Typst Document Template

GitHub Repo stars GitHub release (with filter)

Maintenance Issues GitHub commits since latest release

This is a document template for creating professional-looking documents with Typst, tailored for FHICT (Fontys Hogeschool ICT).

Introduction

Creating well-structured and visually appealing documents is crucial in academic and professional settings. This template is designed to help FHICT students and faculty produce professional looking documents.

Showcase Showcase

Requirements

  • Roboto font installed on your system.
  • Typst builder installed on your system (Explained in Getting Started).

Features

  • Consistent formatting for titles, headings, subheadings, and paragraphs.
  • Clean and professional document layout.
  • FHICT Style.
  • Configurable document options.
  • Helper functions.

Getting Started

To get started with this Typst document template, follow these steps:

  1. Check for the roboto font: Check if you have the roboto font installed on your system. If you don't, you can download it from Google Fonts.
  2. Clone or Download: Start by cloning this repository to your local machine, or download the template ZIP from the latest release (and optionally the starter ZIP for a quick start). If you choose to manually download the individual files, you will only need the template folder.
  3. Install Typst: I recommend to use VSCode with the Typst LSP Extension. You will also need a PDF viewer in VSCode if you want to view the document live.
  4. Import the template: Import the template into your own typst document.
  5. Set the available options: Set the available options in the template file to your liking.
  6. Start writing: Start writing your document.

Not sure how to do the last 3 steps? Check out the showcase document for a reference or grab the starter folder / starter ZIP from the latest release to get a pre made starting point.

Helpful Links / Resources

  • The manual contains a list of all available options and helper functions. It can be found here or attached to the latest release.
  • The Typst Documentation is a great resource for learning how to use Typst.
  • The bibliography file is written in BibTeX. You can use BibTeX Editor to easily create and edit your bibliography.
  • You can use sub files to split your document into multiple files. This is especially useful for large documents.

Contributing

I welcome contributions to improve and expand this document template. If you have ideas, suggestions, or encounter issues, please consider contributing by creating a pull request or issue.

Disclaimer

This template / repository is not endorsed by, directly affiliated with, maintained, authorized or sponsored by Fontys Hogeschool ICT. It is provided as-is, without any warranty or guarantee of any kind. Use at your own risk.

The author was/is a student at Fontys Hogeschool ICT and created this template for personal use. It is shared publicly in the hope that it will be useful to others.

About

A Typst template for FHICT to create professional looking documents with ease

License:MIT License


Languages

Language:Typst 100.0%