ramblingjordan / markdone

Visually pleasing task lists with machine readable components.

Markdone

Markdone is a specification for the format and organization of checklist files for the purpose of personal organization and project planning.

Acknowledgments

• GitHub Flavored Markdown (GFM) - Markdone uses a subset of this specification, Markdone will validate to GFM but not all GFM will validate to Markdone.
• Todo.txt - Markdone borrows a lot from Todo.txt, however we do break or modify formating rules. Even #1!
• Getting Things Done (GTD) - Markdone is designed to facilitate the implementation of a GTD system.

Mission

To combine the human readable styling of Markdown with the machine readable concepts of Todo.txt.

Specification

View specification details.

Command Line Interface (CLI)

CLI Details

Contribution Guidelines

See ./CONTRIBUTING.md

markdone's Issues

What is the purpose of the STOP date?

Standard key words are reserved for dates. start, stop, and due All dates are in the format YYYY-MM-DD

Typically, a completed or closed date is used to identify when a task was closed. The difference between the two is completed indicates that the task was done, while closed is generic and includes cancelled tasks.

Boolean tags break format of KEY:VALUE

A value without a key is considered a flag. It's presense indicates the value is TRUE its absence FALSE eg. :waiting-for

Why break the format TAG:VALUE format? That is, why is the following not good?

A key without a value is considered a flag. It's presense indicates the value is TRUE, its absence FALSE eg. waiting-for: