Welcome to Inkstone

Use the left side to organize notes, the center to edit plain Markdown, and the right side for live preview. There is no proprietary document format: every .md file in a backup opens in any text editor.

Try these now

• Click this checkbox and watch the source update on the left
  • Nested tasks update their exact source line too
• Select text and press Ctrl + B to make it bold
• Press Ctrl + K to open the command palette
• Add a #tag, or click My first note to create a linked note
• Click the title above this note and give it a name different from the body
• Create a subfolder, then drag it into another folder or sibling position
• Alt-click another note, or choose Open to side, to work with two notes at once
• Install Inkstone as an offline-capable PWA under Settings → About
• Open Settings → MCP to review private AI connections and permissions
• Add a backup target under Settings → Backup
• Create a password-protected share for a note

Essential Windows shortcuts

Why it works for long-term notes

Private MCP (optional)

Under Settings → MCP, the owner can enable the remote MCP service and each account can separately decide whether to allow writes or moves to trash:

• Full MCP clients such as Codex and Claude Code authorize through OAuth 2.1 with PKCE. You can revoke one client or every grant at any time.
• Scripts and minimal clients without OAuth can use an ink_... API key. A key is shown once, stored only as a hash, and can be revoked at any time.
• MCP can search, read bounded ranges, inspect outlines/folders/tags/links, and—with explicit permission—safely create, edit, organize, trash, or restore notes. Permanent purge is never exposed.
• With Workers AI configured, Inkstone builds a per-account semantic index and combines semantic and keyword results. The index can be rebuilt or cleared, and content changes are indexed in the background.

Markdown quick reference

Under each example title, the rendered result is on the left and the copyable source is on the right.

Inline styles

Links, images, and note relationships

[Open the example site](https://example.com)

![Inkstone project logo](/inkstone-logo.svg "Inkstone project logo")

[[My first note|Open or create a note]] · [[Welcome to Inkstone#Markdown quick reference|Jump to this section]]

This content can be addressed precisely. ^markdown-demo

Click [[#^markdown-demo]] to return to it.

This content is embedded again below. ^embed-demo

![[#^embed-demo|Embedded result]]

This sentence has an additional note.[^markdown-footnote]

[^markdown-footnote]: This is the rendered footnote. Use its links to move between the reference and definition.

Obsidian comments are hidden in preview: %% one line %%, or place %% markers around multiple lines.

Math and diagrams

Inline math: $E = mc^2$

$$
a^2 + b^2 = c^2
$$

```mermaid
flowchart LR
  A[Markdown source] --> B[Live preview]
```

Modern block extensions

> [!NOTE]- Folded callout with a custom title
> Put explanations, tasks, lists, or other Markdown here.
>
> > [!TIP]+ Expanded nested callout
> > Nested callouts use the same syntax.

::: details [Click to expand]
This content is hidden until the details block is opened.
:::

:::: tabs
::: tab-item First tab
This is the first tab panel.
:::

::: tab-item Second tab
This is the second tab panel.
:::
::::

const name = 'Inkstone'
console.log(`Hello, ${name}!`)

```ts title="hello.ts" line-numbers {2}
const name = 'Inkstone'
console.log(`Hello, ${name}!`)
```

Saving, syncing, and recovery

Changes save automatically and sync to your other devices. You can keep editing offline, and queued writes replay in order after reconnection. Everyday actions appear locally first and roll back only if background persistence fails; stale sync responses cannot overwrite newer local state.

Install the PWA under Settings → About. Application updates wait for confirmation and flush pending note writes before refreshing; only the owner receives deployment-version reminders. Existing databases upgrade through versioned, idempotent migrations, but keep a current backup before updating a self-hosted deployment.

Add several WebDAV/S3 destinations and a schedule under Settings → Backup. Import or export .md, .zip, and complete JSON archives under Settings → Data.

You are ready

Press Ctrl + , to change the interface language, theme, typography, editor, sync, or backup settings. You now know everything needed to use Inkstone. Keep this note as a reference or delete it and start writing.