Documentation
inkwell stores your notes as plain markdown files in a folder you choose. These guides walk through every feature, step by step. New here? Start with Getting started, or press ⌘KCtrl+K to search.
Start
Write
- Writing in the editorFormat text, use slash commands, switch between Normal and Markdown mode, and move around long notes.
- Math (LaTeX)Write inline and display equations with LaTeX, rendered live in the editor and in exports.
- TablesAdd simple markdown tables or richer, Notion-style tables with typed columns right inside a note.
- ChartsTurn numbers into bar, line, area, pie and donut charts that live inside your notes.
- Boards and tasksPlan work on Kanban boards with columns, cards, due dates, subtasks and comments, then drop a live board or task into any note.
- Attachments and mediaAdd images, PDFs and other files to a note, embed them inline, and manage them from the media panel.
Organise
- Organising notesGroup notes in folders, rename and reorder them, pin favourites, and choose between a note list and tabs.
- Linking notesConnect a note to other notes and boards, jump between them, and mention notes right in your writing.
- SearchFind any note in your vault by title, content or tag, from anywhere in the app.
- CanvasSketch diagrams, flows and mind maps on an infinite canvas, start from templates, and attach notes to shapes.
- BrainstormThink in nested points, switch between an outline and a mind map of the same data, and embed a live outline in any note.
- Quick captureJot down a note from anywhere on your computer with a global shortcut, without opening the main window.
Share
- Real-time collaborationShare a vault with teammates, edit the same notes together, and keep working offline.
- Sharing and exportingExport a note as Markdown, HTML or PDF, preview it first, or copy it to the clipboard.
- GitHub syncConnect GitHub once, then push notes to a repository as .md files and pull the latest version back.
- External changes and conflictsHow inkwell notices edits made outside the app, what the conflict banner means, and a good setup for syncing across devices.
Customise
Reference
- Keyboard shortcutsEvery keyboard shortcut in inkwell in one searchable table, for macOS, Windows and Linux.
- Troubleshooting and FAQQuick answers to common questions, plus fixes for the problems people hit most often.
- Build from sourceSet up the tools, run inkwell in development, and build installers for macOS, Windows and Linux.