Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SkytAsul/INSA-Typst-Template
Typst Template for documents from the french engineering school INSA.
https://github.com/SkytAsul/INSA-Typst-Template
Last synced: 3 months ago
JSON representation
Typst Template for documents from the french engineering school INSA.
- Host: GitHub
- URL: https://github.com/SkytAsul/INSA-Typst-Template
- Owner: SkytAsul
- License: mit
- Created: 2024-01-21T11:35:45.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-03-23T12:15:04.000Z (3 months ago)
- Last Synced: 2024-03-24T11:59:37.121Z (3 months ago)
- Language: Typst
- Homepage:
- Size: 1.95 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-typst - INSA Typst Template - A template for INSA (Institut National des Sciences Appliquées), a french public engineering school. (Templates & Libraries / General)
README
%5D.version&style=for-the-badge&label=Report%20Version&color=red)
%5D.version&style=for-the-badge&label=Letter%20Version&color=orange)
# INSA - Typst Template
Typst Template for documents from the french engineering school INSA.
## Examples
You can find examples for the 3 document types [in the `exemples` folder](exemples).
## Usage
### From online package
Templates are available in the official Typst templates repository (Typst Universe):
- `insa-report` and `insa-full` are under the name [`silky-report-insa`](https://typst.app/universe/template/silky-report-insa)
- `insa-short` is under the name [`silky-letter-insa`](https://typst.app/universe/template/silky-letter-insa)
There are multiple ways to use them:
- From the [Typst web application](https://typst.app/), 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
```sh
$ typst init @preview/:
```
- If you want to add it to an existing project, copy the `#show` rule from an example [in the `exemples` folder](exemples) *but* replace the `import` by this line:
```typst
#import "@preview/:": *
```
> [!IMPORTANT]
> (replace `` by the one you need and `` by the latest version available, see at the top)
### From sources (editable version)
1. Download the code from GitHub. To do that, click on the green "Code" button and then "Download ZIP".
1. Open the ZIP archive file and copy the `insa-template` folder in the directory with your Typst project.
1. (*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.
1. (*OPTIONAL*) After creating the folder, simply drag all the files you downloaded in it (`template.typ, cover.jpg, footer.png, logo.png`).
1. Add this line at the beginning of your Typst file (by default, `main.typ`):
```typst
#import "insa-template/template.typ" : *
```
1. Choose between the 3 available templates: `insa-full`, `insa-short` or `insa-report`.
1. Copy the `#show` rule from the example document of the template you chose to your Typst file. In example:
```typst
#show: doc => insa-short(
author: [
Youenn LE JEUNE\
3 INFO G2.1
],
doc
)
````
1. Enjoy!
## 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 `Typst LSP` And `Typst Preview` extensions.
You can also directly edit your Typst files with a simple text editor and compile it with the Typst CLI.
See [Installation](https://github.com/typst/typst?tab=readme-ov-file#installation) and [Usage](https://github.com/typst/typst?tab=readme-ov-file#usage) sections on the official Typst repository.