tleskin / todoist-api

The official Todoist API documentation source

todoist-api - The official Todoist API documentation source

Getting started

Prerequisites

You're going to need:

• Ruby, version 1.9.3 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting set up

1. Fork this repository on Github.
2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/todoist-api.git
3. cd todoist-api
4. Install all dependencies: bundle install
5. Start the test server: bundle exec middleman server

You can now see the docs at http://localhost:4567. And as you edit source/index.md, your server should automatically update.

Now that all is setup in your machine, you'll probably want to learn more about the Slate template, which is used for this API documenentation. There is a lot of articles on it at the Slate wiki.