README
WARNING: This package is deprecated
To get the latest and greatest from the imdone team, try the imdone-atom, atom editor package.
Active development has ceased on piascikj/imdone. A stand alone app, that like imdone-atom will also sync your TODO comments with imdone.io and subsequently issues in a variety of products including github, waffle, trello, jira and twitter is being developed at imdone/imdone.
Put TODOs in their place!
Stay in the loop
iMDone for Chrome
iMDone is now available as a chrome app at iMDone - Chrome Web Store.
This project is on hold so I can foucs more of my time on the chrome app.
iMDone for chrome is now more feature rich than iMDone and is available for your friends who don't know npm or node!
You can read more about it at the iMDone Blog.
Introduction
When working on a software project in code or writing project in markdown, there are always tasks you need to record. Most people use a separate tool to record tasks and keep track of their progress. iMDone let's you do it right in your work.
Features
- Supports code style comments like this in code files
// FIXME: this is really broken
- Create tasks in any text file using markdown link syntax like
[Finish the latest blog post](#doing:0)
- or with a hashtag
#doing:0 Finish the latest blog post
- Sort tasks and move them between lists with drag and drop
- Select and move multiple tasks at once
- Reorder lists
- Hide and show lists
- Task filters (Regular Expression syntax)
- Search (Regular Expression syntax)
- Create, delete and edit files
- Code completion with ctrl+space in editor
- Markdown preview with table of contents
- Syntax highlighting in markdown code blocks
- Use gollum link syntax
- Great for managing github wikis
- Execute an event listener for modified files
Quickstart
- Install
sudo npm install -g imdone
- Run iMDone by opening a terminal window, navigate to your local project directory and run...
imdone -o
- or for help...
imdone -h
- Open a file by clicking on the folder icon and create a task like this
[Use imdone to manage tasks in my project](#done:0)
- Or like this
When your in the middle of a scentence #todo:0 write a task like this.
- Or create tasks like this in code files (javascript example)
// TODO: Use HashMap instead of HashTable
- Add another project by navigating to the project directory in the terminal and run...
imdone
Configuration
After running imdone for the first time, modify .imdone/config.json
in your project directory. The default config looks like this. Your .imdone/config.json
will extend this:
{
"exclude": [
"^(node_modules|bower_components|\\.imdone|target|build)\\/?|\\.(git|svn)|\\~$|\\.(jpg|png|gif|swp|ttf|otf)