Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .generated/content.json

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions app/globals.css
Original file line number Diff line number Diff line change
Expand Up @@ -967,6 +967,35 @@ video {
font: 400 0.72rem/1.5 var(--mono);
}

.app-walkthrough {
margin: 1.5rem 0;
}

.app-walkthrough video {
width: 100%;
max-height: none;
margin: 0;
aspect-ratio: 3 / 2;
background: var(--color-surface-subtle);
}

.app-walkthrough figcaption {
margin-top: 0.65rem;
color: var(--color-text-soft);
font-size: 0.875rem;
line-height: 1.5;
}

.walkthrough-transcript summary {
padding: 0.65rem 0;
font-weight: 700;
cursor: pointer;
}

.walkthrough-transcript[open] summary {
margin-bottom: 1rem;
}

.media-frame {
position: relative;
width: 100%;
Expand Down
5 changes: 3 additions & 2 deletions content/app/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ copy of your Markdown lives: hosted online or on your own computer.

If mdbase is new to you, start with [mdbase and TaskNotes](/app/mdbase/) for a
plain-language explanation of the format, Connect desktop app, and hosting
choices.
choices. For a video and written setup steps, follow
[Connect TaskNotes to mdbase](/app/connect-mdbase/).

## Hosted mdbase

Expand All @@ -39,5 +40,5 @@ mdbase Connect background service whenever you use TaskNotes. See how to

## Change collections later

Open **More** and choose **Change collection**. Opening another collection does
Open **Settings** and choose **Change collection**. Opening another collection does
not copy or move records from the collection you were using.
150 changes: 150 additions & 0 deletions content/app/connect-mdbase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
title: Connect TaskNotes to mdbase
description: Watch how to connect hosted mdbase collections and existing local folders to the TaskNotes app, with written steps and a transcript.
route: /app/connect-mdbase/
product: app
platforms: [web, android, ios]
---

# Connect TaskNotes to mdbase

<figure class="app-walkthrough">
<video controls playsinline preload="none" width="1440" height="960" poster="/assets/app/connect-mdbase/poster.png" aria-label="Connect TaskNotes to mdbase: hosted collections and existing local folders" aria-describedby="walkthrough-description">
<source src="/assets/app/connect-mdbase/walkthrough.mp4" type="video/mp4">
<track src="/assets/app/connect-mdbase/captions.en.vtt" kind="captions" srclang="en" label="English">
<p>Your browser cannot play this video. <a href="/assets/app/connect-mdbase/walkthrough.mp4">Download the MP4</a> or read the written steps and transcript below.</p>
</video>
<figcaption id="walkthrough-description">3 minutes 53 seconds · Silent walkthrough with on-screen instructions and visible cursors. Use the player’s fullscreen control for a closer view.</figcaption>
</figure>

<a href="/assets/app/connect-mdbase/walkthrough.mp4" download>Download the video</a>
· [Read the transcript](#transcript)

These instructions are for the web, Android, and iOS app, not the
[Obsidian plugin](/obsidian/).

The recording uses disposable demo data in the LAB test environment. Account
sign-in and OS-specific installer dialogs are omitted. The folder chooser and
Markdown editor shown are Linux examples; the connection steps apply across
platforms. TaskNotes is in beta, so some labels may change.

## Choose where your collection lives

- **Hosted by mdbase:** available online even when your computer is off. You
need an internet connection, but not the desktop Connector to use TaskNotes.
- **On your computer:** files stay in a local folder. Keep that computer
reachable and mdbase Connect running while other devices use the collection.

Hosted collections can also be mirrored to your computer, so you can work
with local Markdown files. Mirror setup is outside this walkthrough.

The same TaskNotes app works with either. Read [What is mdbase?](/app/mdbase/)
for more background or [Choose a collection](/app/collections/) for a fuller
comparison.

## Connect a hosted collection

1. Open [TaskNotes](https://app.tasknotes.dev/) or its Android or iOS app and
choose a collection. Sign in to mdbase if asked.
2. Select a collection labelled **Hosted by mdbase**, then choose **Review
access**.
3. Review the named application, collection, requested actions, and setup
changes. Approve only if you agree. For a collection needing TaskNotes
definitions, the button reads **Set up and allow access**.
4. Return to TaskNotes and add a task. It is saved in the hosted collection.

If you do not have a hosted collection, expand **Add or connect another
collection → Create hosted collection** in mdbase. Creating a collection and
approving TaskNotes access are separate steps.

## Connect an existing local folder

1. Visit the [mdbase Connect download page](https://mdbase.dev/downloads/) and
choose the **desktop app** for your operating system and processor. Follow
the current platform installation and beta security guidance, then open
mdbase Connect. The standalone CLI download does not include the desktop
interface.
2. Name your computer and choose **Continue in browser**. Sign in if asked,
approve the computer, then return to the desktop app and wait for it to
connect.
3. Open **Collections → Add existing**. Select the collection root containing
`mdbase.yaml`, not just its `tasks` subfolder. Adding the folder validates it
in place; it does not move or upload its files.
4. Open the collection chooser in TaskNotes and select the collection listed
under your connected computer. If TaskNotes already has a collection open,
use **Settings → Change collection → Connect another collection**.
5. Review and approve the requested access and setup changes if you agree.
If TaskNotes subsequently asks, review **Apply reviewed setup** as well.
6. Add a task and inspect its Markdown file in the collection. Completing the
task updates that file’s status to `done`. You can use any Markdown editor;
the video uses VS Code.

TaskNotes does not open the folder directly or maintain a durable offline copy.
Your computer remains the main copy and must be reachable for remote access.
See [Connection and availability](/app/connection/) if the collection cannot
be reached.

## Switch an existing connection

Open **Settings → Change collection** and select a collection you have already
approved. **Connect another collection** returns to mdbase to approve access
to another one. Switching collections does not copy or move their records.

## Transcript

<details class="walkthrough-transcript">
<summary>Read the full video transcript</summary>

**00:00** — This video shows how to connect mdbase collections to the TaskNotes app. We’ll start with a hosted collection, then connect an existing folder on your computer.

**00:08** — Hosted by mdbase: available online, even when your computer is off. No desktop Connector needed for TaskNotes.

**00:14** — Hosted collections can also be mirrored to your computer, so you can work with local Markdown files.

**00:21** — On your computer: files stay in an existing folder. Keep mdbase Connect running and the computer reachable. The same TaskNotes app works with either.

**00:29** — Start with hosted: open app.tasknotes.dev and choose a collection.

**00:37** — Select a collection labelled Hosted by mdbase, then review access.

**00:50** — Review the permissions, then approve access if you agree.

**01:00** — Add a task. It is saved in your hosted collection; no local computer is needed.

**01:14** — Already have an mdbase collection on your computer? Connect that folder to TaskNotes without moving its files.

**01:22** — For a local folder, first get the desktop app at mdbase.dev/downloads.

**01:35** — Install and open mdbase Connect.

**01:39** — Name this computer, then choose Continue in browser.

**01:49** — Sign in if asked, then approve this computer.

**02:00** — In Collections, choose Add existing and select your collection folder.

**02:09** — Choose the folder containing mdbase.yaml. Its files stay where they are.

**02:15** — Back in TaskNotes, open the mdbase collection chooser.

**02:21** — Select the collection listed under your connected computer.

**02:35** — Review the requested access and setup changes, then approve if you agree.

**02:44** — Add a task to the local collection.

**02:59** — Each task is a Markdown file. Changes you make in TaskNotes are saved back to the collection.

**03:06** — The task is now a Markdown file in your existing folder.

**03:11** — Keep mdbase Connect running while other devices use this folder.

**03:15** — Once both are connected, switch collections in Settings → Change collection.

**03:24** — Choose a collection you have already approved.

**03:37** — In the local collection, complete the task.

**03:46** — The same Markdown file now says status: done.

</details>
15 changes: 9 additions & 6 deletions content/app/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@ The web and native applications use the same task interface.

## 2. Choose a collection

TaskNotes opens every collection through mdbase. Choose **Hosted mdbase** for a
collection available anywhere with a network connection, or **Connect to a
computer** to use a Markdown collection kept on your own computer through the
encrypted relay. Read [What is mdbase?](/app/mdbase/) if this is new to you,
then [Choose a collection](/app/collections/) to compare the two options.
TaskNotes opens every collection through mdbase. In the collection chooser,
select one labelled **Hosted by mdbase** or one listed under your connected
computer. Read [What is mdbase?](/app/mdbase/) if this is new to you, then
[Choose a collection](/app/collections/) to compare the two options.

Follow [Connect TaskNotes to mdbase](/app/connect-mdbase/) for a short video,
written steps, and a transcript covering hosted collections first, then
existing local folders.

## 3. Create a task

Expand All @@ -41,5 +44,5 @@ Navigation belongs to the current collection and can be reordered from Views.

## 5. Check collection status

Open **More** to see the collection location, connection state, last refresh,
Open **Settings** to see the collection location, connection state, last refresh,
notification access, task model settings, and appearance preference.
3 changes: 2 additions & 1 deletion content/app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ changes require a connection.

1. [Try TaskNotes with sample tasks](/app/demo/) or [open or install TaskNotes](/app/getting-started/).
2. [Learn how mdbase supports TaskNotes](/app/mdbase/).
3. [Choose where your collection lives](/app/collections/).
3. [Choose where your collection lives](/app/collections/), then follow the
[connection walkthrough](/app/connect-mdbase/) with video and written steps.
4. Create a task and open **Today**.
5. Turn on reminders only if the collection and platform support delivery.

Expand Down
3 changes: 2 additions & 1 deletion content/app/mdbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ saving changes require a connection.
| Connect to your computer | In a folder on your computer | Both devices must be online, and your computer must be running mdbase Connect |

[Choose a collection](/app/collections/) compares the TaskNotes behavior of
these options in more detail.
these options in more detail. [Connect TaskNotes to mdbase](/app/connect-mdbase/)
shows both connection flows in a short video, with written steps and a transcript.

## Use a collection on your computer

Expand Down
2 changes: 2 additions & 0 deletions navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ navigation:
items:
- title: Get started
route: /app/getting-started/
- title: Connect to mdbase
route: /app/connect-mdbase/
- title: Interactive demo
route: /app/demo/
- title: Choose a collection
Expand Down
79 changes: 79 additions & 0 deletions public/assets/app/connect-mdbase/captions.en.vtt
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
WEBVTT

00:00:00.000 --> 00:00:08.000
This video shows how to connect mdbase collections to the TaskNotes app. We’ll start with a hosted collection, then connect an existing folder on your computer.

00:00:08.000 --> 00:00:14.000
Hosted by mdbase: available online, even when your computer is off. No desktop Connector needed for TaskNotes.

00:00:14.000 --> 00:00:21.000
Hosted collections can also be mirrored to your computer, so you can work with local Markdown files.

00:00:21.000 --> 00:00:29.000
On your computer: files stay in an existing folder. Keep mdbase Connect running and the computer reachable. The same TaskNotes app works with either.

00:00:29.000 --> 00:00:37.600
Start with hosted: open app.tasknotes.dev and choose a collection.

00:00:37.600 --> 00:00:50.833
Select a collection labelled Hosted by mdbase, then review access.

00:00:50.833 --> 00:01:00.033
Review the permissions, then approve access if you agree.

00:01:00.033 --> 00:01:14.067
Add a task. It is saved in your hosted collection; no local computer is needed.

00:01:14.067 --> 00:01:22.067
Already have an mdbase collection on your computer? Connect that folder to TaskNotes without moving its files.

00:01:22.067 --> 00:01:35.933
For a local folder, first get the desktop app at mdbase.dev/downloads.

00:01:35.933 --> 00:01:39.933
Install and open mdbase Connect.

00:01:39.933 --> 00:01:49.467
Name this computer, then choose Continue in browser.

00:01:49.467 --> 00:02:00.400
Sign in if asked, then approve this computer.

00:02:00.400 --> 00:02:09.400
In Collections, choose Add existing and select your collection folder.

00:02:09.400 --> 00:02:15.133
Choose the folder containing mdbase.yaml. Its files stay where they are.

00:02:15.133 --> 00:02:21.933
Back in TaskNotes, open the mdbase collection chooser.

00:02:21.933 --> 00:02:35.333
Select the collection listed under your connected computer.

00:02:35.333 --> 00:02:44.566
Review the requested access and setup changes, then approve if you agree.

00:02:44.566 --> 00:02:59.300
Add a task to the local collection.

00:02:59.300 --> 00:03:06.300
Each task is a Markdown file. Changes you make in TaskNotes are saved back to the collection.

00:03:06.300 --> 00:03:11.500
The task is now a Markdown file in your existing folder.

00:03:11.500 --> 00:03:15.833
Keep mdbase Connect running while other devices use this folder.

00:03:15.833 --> 00:03:24.833
Once both are connected, switch collections in Settings → Change collection.

00:03:24.833 --> 00:03:37.066
Choose a collection you have already approved.

00:03:37.066 --> 00:03:46.066
In the local collection, complete the task.

00:03:46.066 --> 00:03:52.599
The same Markdown file now says status: done.
Binary file added public/assets/app/connect-mdbase/poster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/app/connect-mdbase/walkthrough.mp4
Binary file not shown.
Loading
Loading