Markdone

A syntax for TODO lists based on Markdown.

Markdone is a superset of Markdown. Every Markdone document is a valid Markdown document. Markdone documents extend Markdown syntax by adding TODO lists.

Why Markdone

Text based TODO lists are extremely common. Despite many available online tools and client apps, plain text allows for easy access, editing and portability.

Any text editor can be turned into a simple TODO app by enabling syntax hightlight for Markdone. This allows using editors such as Textmate or Sublime to code and manage TODO lists at the same time.

Syntax hightlight requires a language grammar and a theme that supports said grammar.

Markdone syntax

A Markdone document is comprised of Markdown syntax and TODO lists. TODO lists are regular Markdown lists that always start with a + or - symbol. Lists that start with * remain regular unordered lists.

Each line item of a TODO list is a task:

• Lines that start with - are pending tasks
• Lines that start with + are completed tasks

Eg:

+ Task A
+ Task B
- Task C
+ Task D
- Task F

Subtasks

Sublists can be used to split a task in subtasks

+ This is completed task
	+ This is a subtask
- This is an incomplete task
	- This is an incomplete subtask
	+ Incompleted tasks might have completed subtasks

Tags

Tasks can have metadata in the form of # tags

+ Task A #tag1 #tag2
- Buy milk #store
- Call Dad #7pm

Example

- TODO syntax
	+ Create a github project
	- Define TODO grammar
	- Write TODO tmLanguage for Textmate #pc
	+ Write TODO example
- Call Dad #7pm

Tools

Sublime Text 2

Grammar File

Install the contents of the folder sublime/package (Sublime language files) under

~/Library/Application Support/Sublime Text 2/Packages/Markdone

Syntax Highlight Theme

Install the contents of the folder sublime/themes (Sublime theme files) can under

~/Library/Application Support/Sublime Text 2/Packages/Color Scheme - Default

The Solarized theme has been adapted to support Markdone.

Textmate

[ details to follow ]

Resources

• Markdown & Markdown syntax
• Solarized theme
• todo.txt is another text based TODO list format.