Markdo
Markdown-based task manager. Inspired by OmniFocus, TaskPaper, and GitHub Flavored Markdown's task lists.
Installation
Install Ruby, and then:
gem install markdo
Usage
You might already be using Markdo-formatted text already!
Basically, you write Markdown, and use the GFM "task list" syntax:
# Example
Any Markdown you want
## Like headings
## And subheadings
> Quoted text.
And of course:
- [x] A completed task
- [ ] An incomplete task
- [ ] A subtask
- [ ] @due(2016-01-01) A task with a due date
- [ ] A task with a @tag
Then you can use markdo
to interact with your files.
See markdo help
for more information.
add "string" Add a task to the inbox. (Set $MARKDO_ROOT and $MARKDO_INBOX.)
edit Edit $MARKDO_ROOT in $EDITOR.
help, --help Display this help text.
ics Make an iCalendar feed of all due dates in Markdo. Can be imported
or subscribed to if on a remote server.
overview Get overview of overdue, starred, today's, and tomorrow's tasks.
overdue Search *.md files for previous dates. (YYYY-MM-DD format.)
tag "string" Search *.md files for @string.
today Search *.md files for today's date. (YYYY-MM-DD format.)
tomorrow Search *.md files for tomorrow's date. (YYYY-MM-DD format.)
rss Make an RSS feed of all links in Markdo. Useful as a live bookmark.
star, starred Search *.md files for @star.
summary Display counts.
query, q "string" Search *.md files for string.
version, --version Display the version.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Development Environment
host$ sudo docker build -t markdo .
host$ sudo docker run --rm -v $PWD:/src -i -t markdo
container$ rake