Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

description of todo.txt format in plain text #68

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

description of todo.txt format in plain text #68

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f461458
avance
dinosv Dec 30, 2021
6125997
Update README.md
dinosv Dec 30, 2021
b5bb5a8
Apply suggestions from code review
dinosv Jan 1, 2022
27335f7
suggested sensible changes
dinosv Jan 1, 2022
e609abd
del whitespace in desc block
dinosv Jan 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,21 @@ This is all possible inside `todo.txt`.

## `todo.txt` format rules

<img src="./description.svg" width="100%" height="500">
```
┌───────────────────────────────── Optional - Marks completion
│ ┌────────────────────────────── Optional - Marks priority
│ │ ┌─────────────────────── Optional - Completion date
│ │ │ ┌──────────── Optional - Creation date
│ │ │ │ (must be specified if completion date is)
│ │ │ │ ┌─── Mandatory - Description
│ │ │ │ │ Tags (optional) can be placed anywhere within it
│ ┌┴┐ ┌───┴────┐ ┌───┴────┐ ┌─┴────────────────────────────────────────────────────┐
x (A) 2016-05-20 2016-04-30 measure space for +chapelShelving @chapel due:2016-05-30
└──────┬──────┘ └──┬──┘ └──────┬─────┘
project tag ──────┘ │ │
context tag ──────────────────┘ │
special key-value tag ────────────────────┘
```

Your `todo.txt` is a plain text file. To take advantage of structured task metadata like priority, projects, context, creation, and completion date, there are a few simple but flexible file format rules.

Expand Down