Welcome to the documentation for Resin, a fast, local-first markdown workspace built with Tauri 2, React 19, TypeScript, CodeMirror 6, and SQLite.
The documentation is organized into three main spaces:
Everything you need to know about using Resin as your daily note-taking and knowledge app.
- [[Welcome to Resin]]: Vault structure, local file storage, and why I built Resin.
- [[Editing and formatting]]: Markdown syntax, inline styles, lists, tables, and LaTeX math.
- [[Callouts]]: Built-in callout types, folding syntax, and custom callout styling.
- [[Tasks and checkboxes]]: Interactive checkboxes, multi-state cycles, and keyboard shortcuts.
- [[Mermaid diagrams]]: Vector diagrams in notes and theme-adaptive rendering.
- [[Links and wikilinks]]: Internal links, heading targets, aliases, and autocomplete.
- [[Images and media]]: Pasting images from clipboard, drag-and-drop, resize syntax, and the Media Viewer.
- [[Workspace and tabs]]: Tab management, horizontal and vertical splits, sidebars, and layout persistence.
- [[Context menus]]: Context menus for tab headers, file explorer entries, and editor text selections.
- [[Command palette]]: Keyboard launcher, fuzzy command search, and navigation keys.
- [[Daily notes]]: Daily note creation with
Alt+D, custom date formats, and folder paths. - [[File explorer]]: Vault folder tree, file creation, renaming, and organization.
- [[Tasks]]: Vault-wide task aggregator, status filtering, and live sidebar toggles.
Custom themes, CSS snippets, fonts, DevTools inspection, and CSS variable reference tables.
The complete reference for building extensions, custom views, status bar items, and scoped API methods.