iMDone

A simple scrum board and markdown wiki for geeks.

View project onGitHub

iMDone

Dependency Status NPM version Flattr this

Keep your tasks in your work!!!

A simple scrum board and markdown wiki for geeks. No DB needed! Your tasks are in your source code, so you can share your board on github.

Tasks are just markdown links!!!

Put a task at the top of a list called "todo"
[this is a task](#todo:10)

In javascript code
//[this is a task in javascript code](#todo:0)

Put a task on the bottom of a list called "doing" (giving it a sort value of 1000 will put it at the bottom unless you have tons of tasks in the list)
[this is a task in doing](#todo:20)

Tasks are sorted by the number after the :

More

  • Edit and create files directly in iMDone using the Ace editor!
  • Stay focused on your current task! It's always there in the bottom right corner.
  • Create files by just linking to them in markdown files
  • Preview markdown files and print them as markdown or html!
  • Use it to navigate between markdown files.

Keyboard shortcuts

Ctrl+Shift+s    save file
esc             exit editor/preview
i               when in preview, edit file

Prerequisites

Install

npm install -g imdone

Run

  • open a terminal window and navigate to your local project directory and run:
    imdone -o

  • Here's the help output

    Usage: imdone [options]

    Options:

    -h, --help                output usage information
-V, --version             output the version number
-o, --open                Open imdone in the default browser
-s, --stop                Stop imdone server
-d, --dirs <directories>  A comma separated list of project directories

    Examples:

    Open imdone in a browser with the current working directory as the project root

$ imdone -o

Open imdone in a browser with list of project directories

$ imdone -o -d projects/imdone,projects/myproject

How you can help

If you like iMDone and want to help me make it better, you can make a contribution at pledgie. Every donation is very much appreciated.

Click here to lend your support to: iMDone - TODO, doing, done! and make a donation at www.pledgie.com !

If you have some spare time, then there is no better way to help an open source project than to get involved in one of the following ways.

  • Help diagnose and report problems
  • Suggest fixes by sending in patches
  • Improve the code
  • Help with unit and end-to-end testing
  • Provide peer support on our forum
  • Publish an article on your blog (send the link) to educate others regarding some aspect of the project
  • Help with missing documentation

See it in action!

Fork this repository and run imdone in your local copy. I use imdone for keep track of imdone development.

imdone will create a directory named imdone that will contain your custom configuration and a file to keep your lists in order

  • you should keep the imdone directory in source control

Filter by file name

  • You can filter by the file name the task are in.
  • As you type in the "filter by file name" field, tasks are filtered

Configuration

After running imdone for the first time, modify imdone/imdone.js in your project directory. The default config looks like this. Your imdone.js will extend this.

module.exports = {
    include:/^.*$/,
    exclude:/^(node_modules|imdone|target)\/|\.(git|svn)\/|\~$|\.(jpg|png|gif|swp)$/,
    marked : {
        gfm: true,
        pedantic: false,
        sanitize: true
    }
};

Testing

iMDone has been tested on my Ubuntu 12.04 desktop using chrome 23.0.x and Firefox 19.x. It should work on any machine that has nodejs and npm installed and for auto update of boards, a browser that supports websockets.

Roadmap