Compare commits

..

2 Commits

Author SHA1 Message Date
dccd6c9d6d
style(example): wrapping 2024-10-19 21:37:48 +02:00
45a8a53404
docs(readme): add usage + example 2024-10-19 21:37:41 +02:00
3 changed files with 43 additions and 1 deletions

Binary file not shown.

View File

@ -27,4 +27,5 @@
je soussigné, Ex Péditeur, atteste par la présente sur lhonneur que ce document je soussigné, Ex Péditeur, atteste par la présente sur lhonneur que ce document
a été réalisé avec #link("https://typst.app/")[Typst]. a été réalisé avec #link("https://typst.app/")[Typst].
Les sources sont disponibles à ladresse suivante: #link("https://git.epheme.re/fmouhart/typst-lettre"). Les sources sont disponibles à ladresse suivante:
#link("https://git.epheme.re/fmouhart/typst-lettre").

View File

@ -1 +1,42 @@
A simple template for French letters for typst. A simple template for French letters for typst.
## Usage
To create a letter, write a typst document while defining the following
parameters, with the `lettre.typ` file in the same folder:
```typst
#import "lettre.typ": *
#show link: strong
#show: doc => lettre(
de: [
Sender\
Address
],
pour: [
Recipient\
Address
],
objet: "subject of the letter", // optional
date: "date of sending", // optional
lieu: "location",
introduction: "opening",
cloture: "closing",
signature: "signature",
post: [
post-letter (e.g., post-scriptum)
],
doc
)
```
Now you can fill the letter afterward, and compile your document with:
```bash
typst compile <filename.typ>
```
## Example
An example file is given in the [`exemple.typ`](./exemple.typ) file in the repository.