typ-notes/README.md

53 lines
696 B
Markdown

# notes
A typst template/lib for taking notes.
## Usage
Install the package locally:
```
git clone https://git.pains-perdus.fr/Pains-Perdus/typ-notes.git ~/.local/share/typst/packages/local/notes/0.0.1
```
Use it in `typ` files with:
```
#import "@local/notes:0.0.1": *
```
Or to create a new note:
```
typst init @local/notes <directory>
```
## Features
### Graph
This package import gviz and can render dot graphs:
```
\```dot-render
digraph mygraph {
rankdir="LR";
b -> a;
a -> c;
c -> b;
}
\```
```
### Todo
```
Lorem ipsum dolore #todo[sit] amet
```
## TODO:
- add new raw type with graphviz boillerplate code
- biblio
- add a list of all todo at the end of the file