obsidian-plugin/heroblackink_ultimate-todoist-sync-for-obsidian
1
0
Fork 0
mirror of https://github.com/heroblackink/ultimate-todoist-sync-for-obsidian.git synced 2026-07-22 07:40:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated the readme document.

Browse source
This commit is contained in:
HeroBlackInk 2023-06-05 15:41:50 +08:00
parent bda683784e
commit 5a76316cf3
3 changed files with 35 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -10,51 +10,33 @@ It should be the best Obsidian plugin for synchronizing Todoist tasks so far.
### Settings page ### Settings page
<img src="/attachment/settings.png" width="500"> <img src="/attachment/settings.png" width="500">
### Sync Button
<img src="/attachment/Syncbutton.png" width="500">
## Features ## Features
### Sync from Obsidian to Todoist ###
| Functionality | Manual Sync | Auto Sync | | | Sync from Obsidian to Todoist | Sync from Todoist to Obsidian | Description |
|------------------------|-------------|-----------| |-------------------------|-------------------------------|-------------------------------|-------------|
| Add task | ✅ | ✅ | | Add task | ✅ | 🔜 | |
| Delete task | ✅ | ✅ | | Delete task | ✅ | 🔜 | |
| Modify task content | ✅ | ✅ | | Modify task content | ✅ | ✅ | |
| Modify task due date | ✅ | ✅ | | Modify task due date | ✅ | ✅ | |
| Modify task description | 🔜 | 🔜 | | Modify task description | 🔜 | 🔜 | |
| Modify task labels/tags | ✅ | ✅ | | Modify task labels/tags | ✅ | 🔜 | |
| Mark task as completed | ✅ | ✅ | | Mark task as completed | ✅ | ✅ | |
| Mark task as uncompleted | ✅ | ✅ | | Mark task as uncompleted| ✅ | ✅ | |
| Modify project | 🔜 | 🔜 | | Modify project | 🔜 | 🔜 | |
| Modify section | 🔜 | 🔜 | | Modify section | 🔜 | 🔜 | |
| Modify priority | ✅ | ✅ | | Modify priority | ✅ | 🔜 | Currently, task priority only support one-way synchronization from Todoist to Obsidian. |
| Add reminder | 🔜 | 🔜 | | Add reminder | 🔜 | 🔜 | |
| Move tasks between files| 🔜 | 🔜 | | Move tasks between files| 🔜 | 🔜 | |
| Added-at date | 🔜 | 🔜 | | Added-at date | 🔜 | 🔜 | |
| Completed-at date | 🔜 | 🔜 | | Completed-at date | 🔜 | 🔜 | |
| Task notes | 🔜 | 🔜 | | Task notes | 🔜 | ✅ | Currently, task notes/comments only support one-way synchronization from Todoist to Obsidian. |
### Sync from Todoist to Obsidian
| Functionality | Manual Sync | Auto Sync |
|------------------------|-------------|-----------|
| Add task | 🔜 | 🔜 |
| Delete task | 🔜 | 🔜 |
| Modify task content | ✅ | 🔜 |
| Modify task due date | ✅ | 🔜 |
| Modify task description | 🔜 | 🔜 |
| Modify task labels/tags | 🔜 | 🔜 |
| Mark task as completed | ✅ | 🔜 |
| Mark task as uncompleted | ✅ | 🔜 |
| Modify project | 🔜 | 🔜 |
| Modify section | 🔜 | 🔜 |
| Modify priority | 🔜 | 🔜 |
| Add reminder | 🔜 | 🔜 |
| Added-at date | 🔜 | 🔜 |
| Completed-at date | 🔜 | 🔜 |
| Task notes | 🔜 | 🔜 |
> **Some plugins may modify the current view, such as Kanban, which causes the automatic synchronization function to fail. You need to manually click the sync button.**
## Installation ## Installation
@ -68,17 +50,26 @@ It should be the best Obsidian plugin for synchronizing Todoist tasks so far.
1. In the Obsidian settings, click on the "Plugins" tab and then click the gear icon next to the "Ultimate Todoist Sync for Obsidian" plugin. 1. In the Obsidian settings, click on the "Plugins" tab and then click the gear icon next to the "Ultimate Todoist Sync for Obsidian" plugin.
2. Enter the Todoist API.. 2. Enter the Todoist API..
## Settings
1. Automatic synchronization interval time
The time interval for automatic synchronization is set to 300 seconds by default, which means it runs every 5 minutes. You can modify it yourself.
2. Default project
New tasks will be added to the default project, and you can change the default project in the settings.
3. Full vault sync
By enabling this option, the plugin will automatically add `#todoist` to all tasks, which will modify all files in the vault.
## Usage ## Usage
### task format ### Task format
New tasks will be added to the default project, and you can change the default project in the settings or use a tag with the same name to specify a particular project. Tasks marked with #todoist will be added to Todoist, while tasks without the **#todoist** tag will not be processed. Tasks marked with #todoist will be added to Todoist, while tasks without the **#todoist** tag will not be processed.
| Syntax | Description | Example | | Syntax | Description | Example |
| --- | --- | --- | | --- | --- | --- |
|#todoist|Tasks marked with #todoist will be added to Todoist, while tasks without the **#todoist** tag will not be processed.| `- [ ] task #todoist`| |#todoist|Tasks marked with #todoist will be added to Todoist, while tasks without the **#todoist** tag will not be processed.If you have enabled Full vault sync in the settings, `#todoist` will be added automatically.| `- [ ] task #todoist`|
| 📅YYYY-MM-DD | The date format is 📅YYYY-MM-DD, indicating the due date of a task. | `- [ ] task content 📅2025-02-05 #todoist` <br>Supports the following calendar emojis.📅📆🗓🗓️| | 📅YYYY-MM-DD | The date format is 📅YYYY-MM-DD, indicating the due date of a task. | `- [ ] task content 📅2025-02-05 #todoist` <br>Supports the following calendar emojis.📅📆🗓🗓️|
| #projectTag | New tasks will be added to the default project(For example, inbox .), and you can change the default project in the settings or use a tag with the same name to specify a particular project. | `- [ ]taskA 📅2024-02-04 #todoist` will be added to inbox.<br>`- [ ]taskB 📅2024-02-04 #tag #testProject #todoist` will be added to testProject.| | #projectTag | New tasks will be added to the default project(For example, inbox .), and you can change the default project in the settings or use a tag with the same name to specify a particular project. | `- [ ] taskA #todoist` will be added to inbox.<br>`- [ ]taskB #tag #testProject #todoist` will be added to testProject.|
| #tag | Note that all tags without a project of the same name are treated as normal tags | `- [ ] task #tagA #tagB #tagC #todoist` | | #tag | Note that all tags without a project of the same name are treated as normal tags | `- [ ] task #tagA #tagB #tagC #todoist` |
| `!!<number>` | The priority of the task (a number between 1 and 4, 4 for very urgent and 1 for natural).<br>**Note**: Keep in mind that very urgent is the priority 1 on clients. So, the priority 1 in the client corresponds to the number 4 here (Because that's how the official API of Todoist is designed.). | `- [ ] task !!4 #todoist` | | `!!<number>` | The priority of the task (a number between 1 and 4, 4 for very urgent and 1 for natural).<br>**Note**: Keep in mind that very urgent is the priority 1 on clients. So, the priority 1 in the client corresponds to the number 4 here (Because that's how the official API of Todoist is designed.). | `- [ ] task !!4 #todoist` |

BIN
attachment/Syncbutton.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 125 KiB

BIN
attachment/settings.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 224 KiB

After

Width:  |  Height:  |  Size: 292 KiB