You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: Update Notifications page to note curernt Reminders interop issues
* docs(internal): Brief writeup on docs dependency updates
* docs: Add auto-suggest FAQ about working with other plugins that have auto-suggest
Copy file name to clipboardExpand all lines: docs/README.md
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,13 @@ If you can run docker, this is the easiest way.
49
49
50
50
### Seeing the docs via Docker
51
51
52
-
Now every time you want to see the docs locally, run:
52
+
> Note: If using Windows, there are some interoperability issues with Windows, Docker, and Jekyll.
53
+
> Recommend running the command below from a Windows Subsystem for Linux (WSL) shell,
54
+
> where you can likely get to your Windows user directory via `/mnt/c/Users/<your username>`,
55
+
> and using a browser from inside WSL2 if possible. Otherwise, if running the browser from Windows,
56
+
> at every page load you must change "0.0.0.0" to "localhost" in the browser's address bar.
57
+
58
+
To see the docs locally, run:
53
59
54
60
```bash
55
61
cd obsidian-tasks/docs
@@ -108,3 +114,15 @@ bundle exec jekyll serve
108
114
109
115
In the output, look forthe line containing `Server address:` and open that URLin your local browser.
110
116
It will be something like <http://0.0.0.0:4000/obsidian-tasks/>.
117
+
118
+
## Dependency Management and Updates for the Docs
119
+
120
+
The dependencies forrunning the docs locally are storedin the `Gemfile` (short, equivalent to Javascript `package.json`) and `Gemfile.lock` (auto-generated, equivalent to `yarn.lock`) files.
121
+
The package manager (equivalent to "yarn") is "bundle" [docs here](https://bundler.io/guides/using_bundler_in_applications.html#recommended-workflow). The "docker_start" script runs the initial
122
+
`bundle install` when building the Docker image.
123
+
If seeing issues with dependencies or with running the docs locally, check that the versions in the `Gemfile`, especially "github-pages" are up-to-date. If making edits to the `Gemfile`, you
124
+
will need to run `bundle install` or `bundle update` manually. (You may also need to update `bundle` itself!) Before checking in any changes to `Gemfile.lock`, see the paragraph below.
125
+
126
+
Some dependencies, such as "nokogiri", have platform-specific gems that **should not** be checked into the repo's `Gemfile.lock`.
127
+
For example, Dependabot might add a Linux-specific version of a dependency to the `Gemfile.lock`, which must then be manually edited to remove the Linux-specific version.
128
+
Otherwise, future contributors on non-Linux systems will be unable to build the Docker image or run Jekyll locally.
Copy file name to clipboardExpand all lines: docs/advanced/notifications.md
+23-3Lines changed: 23 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,35 @@ _Note that this is a screenshot of the reminder plugin's settings and not Tasks.
18
18
19
19
## Where to add the reminder date
20
20
21
-
The order is important when writing the task. You have to put the reminder date between the task name and the other fields :
21
+
The order is important when writing the task. Tasks requires the reminder date after the task description and before any other Tasks fields. Reminders [requires no content between the reminder date and the due date](https://uphy.github.io/obsidian-reminder/guide/interop-tasks.html#distinguish-due-date-and-reminder-date).
22
22
23
23
```markdown
24
-
- [ ] #task task name ⏰ YYYY-MM-DD HH:mm ⏫ 🔁 every *** 🛫 YYYY-MM-DD ⏳ YYYY-MM-DD 📅 YYYY-MM-DD
24
+
- [ ] #task task name ⏰ YYYY-MM-DD HH:mm 📅 YYYY-MM-DD ⏫ 🔁 every week 🛫 YYYY-MM-DD ⏳ YYYY-MM-DD
25
25
```
26
26
27
+
---
28
+
29
+
Warning
30
+
{: .label .label-yellow}
31
+
The output of the "Create or Edit Tasks" command will not put the due date directly behind the reminder date where Reminders wants it.
32
+
You must fix this manually if you want to use the Reminders "defer" command;
33
+
**otherwise (as of August 2022), using the Reminders "defer" command will overwrite all information between the ⏰ and 📅 emoji!**
34
+
See [this issue in Reminders to check the current status](https://github.com/uphy/obsidian-reminder/issues/100).
35
+
36
+
---
37
+
27
38
## How to complete the reminder
28
39
29
-
The reminder date doesn't change when completing the task as of yet, the date will change only when you complete it from the reminder popup or from the notification.
40
+
The reminder date doesn't change when completing the task, the date will change only when you complete it from the reminder popup or from the notification.
Copy file name to clipboardExpand all lines: docs/getting-started/auto-suggest.md
+11Lines changed: 11 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -223,6 +223,17 @@ Similarly, you can type some fraction of the word `start` (of whatever length is
223
223
| next month (2022-08-11) | 2022-08-11 |
224
224
| next year (2023-07-11) | 2023-07-11 |
225
225
226
+
### How can I use auto-suggest features from other plugins together with the Tasks auto-suggest?
227
+
228
+
Obsidian plugins such as Tasks cannot tell if you have auto-suggest features from other plugins enabled.
229
+
Therefore it is user responsibility to manage conflicts between auto-suggest features.
230
+
231
+
The Tasks auto-suggest will only appear on lines that start `- [ ]` and contain the global filter (if one is set).
232
+
If you want to use auto-suggest features from another plugin on such lines, make sure that plugin's settings for auto-suggest
233
+
appearance do not overlap with the keywords listed above,
234
+
then increase the 'Minimum match length for auto-suggest' value in the Tasks settings to more characters than used to activate the other plugin's auto-suggest,
235
+
and re-start Obsidian.
236
+
226
237
## Settings
227
238
228
239
Note that like all Tasks settings, after any changes, Obsidian needs to be restarted for the new settings to take effect.
0 commit comments