Code Monkey home page Code Monkey logo

obsidian-todoist-plugin's Introduction

Obsidian x Todoist Plugin

GitHub Workflow Status GitHub release (latest SemVer)

An Obsidian plugin to materialize Todoist task lists in Obsidian notes.

Example gif

Usage

  1. Install the plugin through the Obsidian's community plugins browser.
  2. Enable the plugin in Obsidian.
  3. You should get a prompt asking for your Todoist API token. (If not, you can enter this in the settings).
  4. Place a code block like the following in any note:
    ```todoist
    {
    "name": "My Tasks",
    "filter": "today | overdue"
    }
    ```
  5. Swap to preview mode and the plugin should replace this code block with the materialized result of that filter.

If you are synchronizing your vault, I recommend explicitly ignoring the .obsidian/todoist-token file for security reasons, if possible.

Inputs

Name Required Description Type Default
name โœ“ The title for the materialized query. You can use the {task_count} template which will be replaced by the number of tasks returned by the query. string
filter โœ“ A valid Todoist filter1 string
autorefresh The number of seconds between auto-refreshing. If omitted, the query use the default global settings. number null
sorting Describes how to order the tasks in the query. Can be any of 'priority', 'dateAscending' (aliased as 'date'), 'dateDescending', or multiple of these. string[] []
group Denotes whether this query should have its task grouped by project & section. bool false

Commands

There are also a few commands bundled in with the plugin:

  1. 'Refresh Metadata'

    This command refreshes all the metadata (projects, sections, and labels) for Todoist tasks. This is done at startup.

  2. 'Add Todoist task'

    This command opens up a modal for creating a task in Todoist. You can set the project/section, labels, priority, and due date through this modal. Any text selected when this command is executed will be pulled for the task content.

  3. 'Add Todoist task with the current page'

    Similiar to the previous command, this one also appends a link to the current active page to the task input.

CSS

This plugin comes with default CSS intended for use with the default Obsidian themes.

I also maintain an Obsidian theme which has support out of the box for this plugin, for a complete example of CSS for this plugin, check out the source.


1: There are some exceptions in the Todoist API. Checkout this issue for details.

obsidian-todoist-plugin's People

Contributors

jamiebrynes7 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.