82 lines
1.2 KiB
Markdown
82 lines
1.2 KiB
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;
|
|
}
|
|
\```
|
|
```
|
|
|
|
`digraphLR`, `digraphTB`, `graphLR` and `graphTB` remove boilerplate code where writing in a hurry:
|
|
|
|
```
|
|
\```digraphLR
|
|
a -> b;
|
|
b -> c;
|
|
c -> a;
|
|
\```
|
|
|
|
\```graphTB
|
|
a -- b;
|
|
b -- c;
|
|
c -- a;
|
|
\```
|
|
```
|
|
|
|
### Todo
|
|
|
|
Todos can be defined with the `todo` function. In addition to being highlighted, the unresolved totos are listed at the end of the generated document.
|
|
|
|
```
|
|
Lorem ipsum dolore #todo[sit] amet
|
|
```
|
|
|
|
To mark a todo as resolved without deleting it, you can mark it as such:
|
|
|
|
```
|
|
Lorem ipsum dolore #todo(done: true)[sit] amet
|
|
```
|
|
|
|
To hid todos, you can add this line at the top of the document:
|
|
|
|
```
|
|
#show-todos.update(_ => false)
|
|
```
|
|
|
|
## TODO:
|
|
|
|
- biblio
|
|
- What to do with resolved toto?
|