From 6cb50f80013075682827ebdfb0bf80c97ce97e83 Mon Sep 17 00:00:00 2001 From: Jamie Brynes Date: Wed, 13 Mar 2024 19:45:41 +0000 Subject: [PATCH] docs: add dedicated setup page --- docs/docs/commands/_category_.yml | 2 +- docs/docs/configuration.md | 2 +- docs/docs/overview.md | 16 ++------------ docs/docs/query-blocks.md | 2 +- docs/docs/setup.md | 35 +++++++++++++++++++++++++++++++ 5 files changed, 40 insertions(+), 17 deletions(-) create mode 100644 docs/docs/setup.md diff --git a/docs/docs/commands/_category_.yml b/docs/docs/commands/_category_.yml index 766387d..c6482d8 100644 --- a/docs/docs/commands/_category_.yml +++ b/docs/docs/commands/_category_.yml @@ -1,2 +1,2 @@ label: Commands -position: 3 +position: 4 diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md index 2659fd7..fe31b1b 100644 --- a/docs/docs/configuration.md +++ b/docs/docs/configuration.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Configuration diff --git a/docs/docs/overview.md b/docs/docs/overview.md index e9e45bf..e56b44b 100644 --- a/docs/docs/overview.md +++ b/docs/docs/overview.md @@ -4,21 +4,9 @@ sidebar_position: 1 # Overview +![](../static/img/social-card.jpg) + The Sync with Todoist Plugin is an _**unofficial**_ plugin that allows you to integrate your Todoist tasks in your Obsidian vault. This integration is mostly one way, from Todoist into Obsidian. There is a limited ability to modify your Todoist tasks, but this functionality will be improved in the future. This plugin is designed to work on both desktop and mobile Obsidian clients. - - -## Installation - -There are a few steps to getting up and running with this plugin: - -1. Install the plugin from Obsidian in the 'Community plugins' tab in the settings. -2. After installing the plugin, enable it. -3. You will get a prompt after enabling the plugin asking for your Todoist API token. You can find this in the [Todoist application settings](https://app.todoist.com/app/settings/integrations/developer). -4. Enter your token and select 'Submit'. - -## What's next? - -Once you've set up the plugin you can explore adding [query blocks](./query-blocks), look at how to [add tasks from Obsidian](./commands/add-task), or explore the [plugin configuration](./configuration). diff --git a/docs/docs/query-blocks.md b/docs/docs/query-blocks.md index 656593d..f9c6883 100644 --- a/docs/docs/query-blocks.md +++ b/docs/docs/query-blocks.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # Query Blocks diff --git a/docs/docs/setup.md b/docs/docs/setup.md new file mode 100644 index 0000000..186a940 --- /dev/null +++ b/docs/docs/setup.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 2 +--- + +# Setup + +There are a few steps to get up and running with this plugin. + +## 1. Install plugin + +First we need to install the plugin. You can follow this [handy](https://obsidian.md/plugins?id=todoist-sync-plugin) link to open the plugin's page in Obsidian and install it. + +If you prefer to do it manually: + +1. Open the settings in Obsidian +2. Select 'Community Plugins' in the sidebar +3. If necessary, turn on community plugins. Make sure you are comfortable with the warnings given to you on this page +4. Select 'Browse' and search for "Todoist Sync" +5. Install the plugin + +## 2. Setup API token + +Once the plugin is installed, you'll need to enable and do some initial setup. + +1. Enable the plugin from Obsidian's setting page +2. You should get a popup asking you to provide your [API token](https://todoist.com/help/articles/find-your-api-token-Jpzx9IIlB). +3. Paste your API token into the prompt +4. The prompt will verify that the token provided is valid and will present you with a checkmark if it is +5. Select 'Submit' to complete the setup + +> Note that this token is stored in its own file inside your vault. It can be found at `.obsidian/todoist-token`. If you synchronize your vault, you may choose to explicit ignore this file to avoid the API token leaving your machine. If you choose to do this, you must perform this setup on each device you access your vault on. + +## What's next? + +Once you've set up the plugin you can explore adding [query blocks](./query-blocks), look at how to [add tasks from Obsidian](./commands/add-task), or explore the [plugin configuration](./configuration).