document the 'todo' features
parent
f7ddb12910
commit
7b55d2b37d
16
README.md
16
README.md
|
|
@ -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?
|
||||
|
|
|
|||
Loading…
Reference in New Issue