Skip to content

Latest commit

 

History

History
108 lines (94 loc) · 6.47 KB

README.md

File metadata and controls

108 lines (94 loc) · 6.47 KB
Raw

Typst GitHub License

INSA - Typst Template

Typst Template for documents from the french engineering school INSA.
It was primarily made for INSA Rennes, but it now includes INSA HdF assets and INSA CVL assets and should be easily modified to suit other INSA schools.

Examples

You can find examples for the all the document types in the exemples folder.

Usage

From the online package

Templates are available in the official Typst templates repository (Typst Universe):

There are multiple ways to use them:

  • From the Typst web application, click on the "Start from template" button and search for the template you want in the list. Click on it, select a name, and click on "Create". Voilà!
  • If you want to initialize a new project through the CLI, use 
    $ typst init @preview/<template-name>:<version>
  • If you want to add it to an existing project, copy the #show rule from an example in the exemples folder but replace the import by this line: 
    #import "@preview/<template-name>:<version>": *

Important

Replace <template-name> by the one you need and <version> by the latest version available, see at the top.

From sources (editable version)

  1. Create a Typst project, either from the CLI (typst init) or from the Web application.
  2. Download the code from GitHub. To do that, click on the green "Code" button and then "Download ZIP".
    illustration
  3. Open the ZIP archive file and copy the insa-template folder in the directory with your Typst project.
  4. (OPTIONAL) If you are using the Typst web application, you have to first create the insa-template folder by clicking on the little folder button in the "Files" panel.
    illustration
  5. (OPTIONAL) After creating the folder, simply drag all the files from insa-template that you downloaded in it
  6. At this point, your file hierarchy should look like this: 
    insa-template/
├── document-template.typ
├── letter-template.typ
└── assets/
    ├── back-cover1.png
    ├── ...
    └── logo.png
main.typ
  7. Choose between the available templates: insa-document, insa-report, insa-stage, insa-letter or insa-slides.
  8. Add this line at the beginning of your Typst file (by default, main.typ): 
    #import "insa-template/letter-template.typ" : * // for letters and short documents
#import "insa-template/document-template.typ" : * // for reports, stages and full documents
#import "insa-template/slides-template.typ" : * // for presentations
  9. Copy the #show rule from the example document of the template you chose to your Typst file. In example: 
    #show: doc => insa-letter(
  author: [
    Youenn LE JEUNE\
    3 INFO G2.1
  ],
  doc
)
  10. Enjoy!

Fonts (polices)

The graphic charter recommends the fonts League Spartan for headings and Source Serif for regular text. To have the best look, you should install those fonts.

To behave correctly on computers lacking those specific fonts, this template will automatically fallback to similar ones:

  • League Spartan -> Arial (approved by INSA's graphic charter, by default in Windows) -> Liberation Sans (by default in most Linux)
  • Source Serif -> Source Serif 4 (downloadable for free) -> Georgia (approved by the graphic charter) -> default Typst font

The recommended fonts are included in this repository under /fonts.

Note on variable fonts

If you want to install those fonts on your computer, Typst might not recognize them if you install their Variable versions. You should install the static versions: League Spartan Bold and most versions of Source Serif (Regular, Bold and Italic).

Keep an eye on the issue in Typst bug tracker to see when variable fonts will be used!

Platforms

The template can be used in the web Typst editor and in a local environment.

I personnally prefer to use it in Visual Studio Code with the Tinymist Typst extension.

You can also directly edit your Typst files with a simple text editor and compile it with the Typst CLI. See Installation and Usage sections on the official Typst repository.

License

The typst templates (.typ files) are licensed under MIT.
This license does not apply to:

  • The assets under /insa-template/assets. Those image files are property of Groupe INSA, INSA de Rennes, INSA HdF and INSA CVL.
  • The fonts file under /fonts. Those files are property of their respective authors.