Docs & FAQ · Ink

Where are my notes stored?

In a folder on your computer. On first launch Ink offers ~/Notes or lets you choose another folder, and you can change it later in Settings.

A page is a Markdown file: Projects.md. Its children live in a folder of the same name: Projects/Roadmap.md.
Page details such as icon, cover and tags go in the file's front matter. Keys Ink does not know are preserved.
Images are saved next to the note that uses them.
Canvases are .canvas files, boards are Markdown pages.
Ink's search index, trash and templates live in a hidden .notes folder inside your notes folder. The index is rebuilt on launch if you delete it.

Does it work with Obsidian?

Yes. Open the same folder in both apps.

[[Wiki links]], heading links and ![[embeds]] use the same syntax.
.canvas files use the JSON Canvas format and are written the way Obsidian writes them, so canvases open in both. Unknown fields are kept.
Kanban boards use the Obsidian Kanban plugin's Markdown format.
Ink watches the folder, so edits made in another editor show up.

Keyboard shortcuts

On macOS, read Ctrl as ⌘.

Keyboard shortcuts
Keys	Action
`Ctrl` + `K`	Command palette: search notes and run commands
`Ctrl` + `N`	New page (blank or from a template)
`Ctrl` + `Shift` + `D`	Open or create today's daily note
`Ctrl` + `G`	Graph view (Esc to go back)
`Ctrl` + `,`	Settings
`Ctrl` + `F`	Find in the page or canvas
`Shift` + `1`	Canvas: show everything
`Ctrl` + `\`	Show or hide the sidebar
`Ctrl` + `Shift` + `O`	Show or hide the outline
`/`	Block menu while writing
`[[`	Link to a page, or create one

Privacy

The app. Your notes stay in your folder. There is no account, nothing is uploaded, and the app does not send analytics. Its interface and fonts are bundled, and it loads your notes through a handler that only reads inside your notes folder.

This website. No analytics, no cookies, no third-party requests. Fonts are served from this site. Nothing is stored in your browser; the theme simply follows your system's light or dark setting.

FAQ

Which platforms are supported?

Linux (AppImage) is available now. Windows and macOS builds are configured but not built or tested yet, so there is no download for them. See Download.

Does it sync between devices?

Ink has no sync of its own. Because your notes are plain files, you can keep the folder in any file-sync or backup tool you already trust.

Does it need an internet connection?

No. Everything runs locally. Web link cards fetch a page's title and description only when you add a link.

Why are the builds unsigned?

Code-signing certificates cost money and effort that a small project has not spent yet. Use the checksum on the download page to verify your file.

Can I export my notes?

They are already Markdown files. You can also export a page to Markdown, HTML or PDF, and a canvas to PNG, SVG or PDF.

How do I report a bug or ask for something?

Open an issue on the issue tracker.

Short answers