Convert Figma logo to code with AI

obsidian-tasks-group logoobsidian-tasks

Task management for the Obsidian knowledge base.

3,026
285
3,026
248
View on GitHubView on NPM

Quick Overview

The "obsidian-tasks" project is a plugin for the Obsidian note-taking application that adds task management functionality. It allows users to create, organize, and track tasks directly within their Obsidian notes, providing a seamless integration between note-taking and task management.

Pros

  • Integrated Task Management: The plugin allows users to create, view, and manage tasks directly within their Obsidian notes, eliminating the need for a separate task management tool.
  • Flexible Task Organization: Tasks can be organized using various properties, such as due dates, priorities, and tags, making it easy to keep track of multiple tasks.
  • Powerful Filtering and Sorting: The plugin provides advanced filtering and sorting options, allowing users to quickly find and prioritize their tasks.
  • Customizable Appearance: Users can customize the appearance of the task list, including the display of task properties and the use of icons.

Cons

  • Dependency on Obsidian: The plugin is tightly integrated with the Obsidian application, which means it may not be suitable for users who do not use Obsidian for their note-taking needs.
  • Limited Collaboration Features: The plugin currently lacks built-in collaboration features, which may be a drawback for users who need to work on tasks with a team.
  • Potential Performance Issues: As the number of tasks and notes grows, the plugin may experience performance issues, especially on older or less powerful devices.
  • Learning Curve: The plugin has a relatively steep learning curve, as users need to understand how to effectively use the various task management features within the Obsidian environment.

Code Examples

This project is a plugin for the Obsidian note-taking application, and it does not provide a standalone code library. As such, there are no code examples to include in this overview.

Getting Started

To get started with the "obsidian-tasks" plugin, follow these steps:

  1. Install the Obsidian application, if you haven't already done so.
  2. Open the Obsidian application and navigate to the "Community Plugins" section in the settings.
  3. Search for the "obsidian-tasks" plugin and click the "Install" button.
  4. Once the plugin is installed, you can start creating and managing tasks within your Obsidian notes.

To create a new task, simply type the task description in your note, and the plugin will automatically recognize it as a task. You can then add additional properties, such as due dates, priorities, and tags, using the plugin's commands and settings.

The plugin also provides various commands and shortcuts for managing your tasks, such as filtering, sorting, and marking tasks as complete. You can access these features by using the plugin's command palette or by configuring custom hotkeys.

For more detailed instructions and information on the plugin's features, please refer to the project's documentation on the GitHub repository.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Obsidian Tasks

Task management for the Obsidian knowledge base.

User Guide - Contributing Guide - Roadmap

Track tasks across your entire vault. Query them and mark them as done wherever you want. Supports due dates, recurring tasks (repetition), done dates, sub-set of checklist items, and filtering.

You can toggle the task status in any view or query and it will update the source file.

For changes in each release, please check the releases page: https://github.com/obsidian-tasks-group/obsidian-tasks/releases

Screenshots

  • All screenshots assume the global filter #task which is not set by default (see also installation).
  • The theme is default Obsidian theme.

ACME Tasks The ACME note has some tasks.

Important Project Tasks The Important Project note also has some tasks.

Tasks Queries The Tasks note gathers all tasks from the vault and displays them using queries.

Create or Edit Modal The Tasks: Create or edit command helps you when editing a task.

Installation

Follow the steps below to install Tasks.

  1. Search for "Tasks" in Obsidian's community plugins browser
  2. Enable the plugin in your Obsidian settings (find "Tasks" under "Community plugins").
  3. Check the settings. It makes sense to set the global filter early on (if you want one).
  4. Replace the "Toggle checkbox status" hotkey with "Tasks: Toggle Done".
    • I recommend you remove the original toggle hotkey and set the "Tasks" toggle to Ctrl + Enter (or Cmd + Enter on a mac).

Getting Started

Write some tasks

Create a few tasks in a Markdown note in your vault. For example:

- [ ] Something non-important, with no date
- [ ] Remember to do that important thing - with a due date 📅 2022-12-17
- [ ] Send Kate a birthday card - with a scheduled date 🔁 every January on the 4th ⏳ 2023-01-04

Find out more in Getting Started, and its sub-sections.

Create your first Tasks search

And then write a Tasks search block somewhere in your Obsidian vault, to find the tasks that are interesting.

Here is an example that shows a few different features. View it in Reading or Live Preview modes to see the results.

```tasks
# Only tasks that are not done, that is, which begin like this (but without the quotes):
#   '- [ ] ' or
#   '* [ ] ' or
#   '1. [ ] '
# Indented tasks are supported, but only single-line tasks.
not done

# Tasks due today or earlier:
due before tomorrow

# Restrict to at most 100 tasks.
# If you ask Tasks to display many hundreds or thousands of tasks,
# Obsidian's editing performance really slows down.
limit 100

# Group and sort the output:
group by filename
sort by due reverse
sort by description

# Optionally, ask Tasks to explain how it interpreted this query:
explain
```

Find out more in Queries, and its sub-sections.

Documentation

For user documentation, please check https://publish.obsidian.md/tasks/.

Development

Clone the repository, run yarn to install the dependencies, and run yarn dev to compile the plugin and watch file changes.

Then see the Contributing Guide.

Donations

The plugin is completely free to use, and very willingly developed and supported by Clare Macrae since May 2022.

If you have particularly been helped by the Tasks plugin and wish to support it, please see the following link.

Donations will go towards my computing costs and licenses for development tools that I use for productivity.

Thank you 🙏.