typst-templates/README.md
dogeystamp 9ea17ae6e9
README.md: misc changes
Reorganize header for Example usage, add note about submodule
2023-05-20 13:31:26 -04:00

53 lines
1015 B
Markdown

# typst templates
Personal templates for [Typst](https://github.com/typst/typst), a neat markdown-like typsetting system.
I have the following directory structure for these:
```
docs/
├── problems
│   ├── src
│   │   └── test.cpp
│   ├── test.pdf
│   └── test.typ
└── templates
└── ...
```
Personally, I set up templates as a git submodule, and docs as another git repo.
## Example usage
Example usage (this is test.typ in the above tree:)
```typ
#import "../templates/problems.typ": template, source_code, status
#show: template.with(
title: "CCC '22 J1 - Cupcake Party",
problem_url: "https://dmoj.ca/problem/cc22j1",
stat: "incomplete",
)
= Thought process
#lorem(20)
== Important things
#lorem(50)
#source_code("test")
```
Need fonts:
- Fira Math
- JetBrains Mono
- Roboto
Some settings are available in `main.typ`.
## Screenshots
![preview](https://raw.githubusercontent.com/dogeystamp/typst-templates/master/preview.jpg)