typst-lettre/readme.md
Fabrice Mouhartem 9af1dcb98b
fix(template): fix the display of location and date
- extra space
- without the location, the comma still appeared
- docs(readme): add the optional comment for the sending location
2024-10-20 11:24:05 +02:00

42 lines
813 B
Markdown

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`](./lettre.typ) file in the same folder:
```typst
#import "lettre.typ": *
#show: doc => lettre(
de: [
Sender\
Address
],
pour: [
Recipient\
Address
],
objet: "subject of the letter", // optional
date: "date of sending", // optional
lieu: "location", // optional
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.