document the 'todo' features

main
Jean-Marie 'Histausse' Mineau 2024-03-21 17:20:04 +01:00
parent f7ddb12910
commit 7b55d2b37d
Signed by: histausse
GPG Key ID: B66AEEDA9B645AD2
2 changed files with 16 additions and 2 deletions

View File

@ -57,11 +57,25 @@ 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
- add a list of all todo at the end of the file
- What to do with resolved toto?

View File

@ -29,5 +29,5 @@
#show raw.where(lang: "graphLR"): it => render-image("graph mygraph { rankdir=\"TB\";" + it.text + "}")
#show raw.where(lang: "graphTB"): it => render-image("graph mygraph { rankdir=\"TB\";" + it.text + "}")
#doc
#todos
#todos()
]