A Notion-style, local-first block editor for the web. Built with Tiptap, React 19, TailwindCSS and shadcn/ui — entirely from free Tiptap extensions.
| 📝 Notion-style writing | Slash / commands, selection bubble menu with Turn-into dropdown, floating + button on empty lines |
| 📋 Google Docs-style menu bar | Full File / Edit / View / Insert / Format / Tools / Extensions / Help menus with cascading submenus |
| 🖱️ Drag handle + block menu | Hover any block to reveal ⋮⋮ and + icons. Drag to reorder, click for Turn into / Duplicate / Delete / Reset / colors / highlight |
| 🗂 Multi-document workspace | Create, rename, duplicate, delete, star and emoji-tag pages from the sidebar |
| 🎨 Cover images | Pick from a built-in Unsplash gallery, paste a URL, or upload from disk |
| 💾 Local-first persistence | Auto-saves every keystroke to localStorage. No accounts, no servers, no telemetry |
| 🌓 Dark / light / system theme | Persisted across sessions, respects OS preference |
| 🔍 Find / Replace | ⌘F to find, ⌘⇧H to replace, with case-sensitive toggle |
| ⌘ Command palette | ⌘K to jump between pages, create from templates, run actions |
| 🧵 Inline threads (free!) | Comment on selections with replies and resolve — works without Tiptap Pro/Cloud |
| @ Page mentions | @ to link to other pages with autocomplete |
| 📐 Outline panel | Auto-generated table of contents that scrolls to headings |
| 🧮 Math equations | Inline $x$ and block LaTeX rendered with KaTeX |
| ⚡ Smart typography | Smart quotes, em-dashes, ellipses, arrows |
| ☑️ Task lists | [ ] checkboxes with nesting |
| 🔗 Smart links | In-place popover that accepts URL or email (auto-prefixes https:// for bare domains and mailto: for emails); auto-link + paste-to-link; opens in a new tab safely |
| 🖼 Media | Images, YouTube embeds, resizable tables |
| 💻 Syntax-highlighted code | Powered by lowlight |
| 📥 Import / Export | .docx import (via mammoth); export to Markdown / HTML / Plain text / JSON / PDF (Print) plus clipboard copy |
| 🔢 Word count dialog | Words, characters (with/without spaces), sentences, paragraphs, reading time |
| 🔠 Rich formatting | H1–H6, alignment, line spacing, font family, text/highlight colors, change-case (UPPER/lower/Title/Sentence), super/subscript |
| ✨ Insert anything | Page break, signature line, special characters, emoji picker, today's date / current time |
| 🔎 Zoom | ⌘+ / ⌘- / ⌘0 to zoom the editor surface |
| ⌨️ Keyboard-friendly | All standard shortcuts (⌘B, ⌘I, ⌘K, ⌘Z, …) |
| 🚀 Production performance | Code-split bundles, lazy-loaded heavy deps, no moment.js |
Free-extension only. This project avoids paid Tiptap Cloud / Pro features (Comments, Drag-context-menu, etc.). The drag handle uses the open-source
@tiptap/extension-drag-handle-react; threads are implemented as a custom mark; the block menu is built from shadcn/ui primitives.
| Menu | What's inside |
|---|---|
| File | New (blank + every template), Open, Make a copy, Rename, Star, Set emoji, Cover image, Import .docx, Download (Markdown / HTML / TXT / JSON / PDF), Print, Move to trash |
| Edit | Undo, Redo, Cut, Copy, Paste, Paste without formatting, Select all, Delete selection, Find, Find & replace |
| View | Show toolbar, Read-only mode, Zoom (50–200%), Theme (Light / Dark / System), Full screen |
| Insert | Image, Link, Cover image, Table (3×3 + custom), Code block, Quote, Horizontal divider, Line break, Page break, Signature line, YouTube, LaTeX equation (block / inline), Mention, Date / time, Special character, Emoji |
| Format | Text marks, Paragraph styles (Normal + H1–H6), Align, Line spacing, Lists & indent, Text color, Highlight, Font family, Change case, Clear formatting |
| Tools | Word count, Command palette, Find & replace, Copy as Markdown / HTML, Reading mode, Spelling suggestions |
| Extensions | Templates, Browse Tiptap extensions, GitHub repo |
| Help | Keyboard shortcuts, About, Report a bug, GitHub repo, Tiptap docs |
# Requires Node >= 18.18
npm install
npm run devThen open http://localhost:5173.
npm run build # type-check + production build
npm run preview # preview the production build locally
npm run typecheck # tsc --noEmit
npm run lint # eslint- Editor: Tiptap 3 on ProseMirror
- Drag handle:
@tiptap/extension-drag-handle-react(free, open source) - Framework: React 19 + React Router 7
- Build: Vite 7 with manual chunking
- Styling: TailwindCSS 4, @tailwindcss/typography
- UI primitives: Radix UI + shadcn/ui patterns
- Icons: lucide-react
- Math: KaTeX
- Date utils: date-fns
- Suggestion popups: tippy.js
- Language: TypeScript (strict mode)
| Shortcut | Action |
|---|---|
/ |
Open the slash command menu |
@ |
Mention / link another page |
⌘ K |
Open the command palette |
⌘ F |
Find in page |
⌘ ⇧ H |
Find & replace |
⌘ / |
Show shortcuts cheatsheet |
⌘ + / ⌘ - / ⌘ 0 |
Zoom in / out / reset |
⌘ B |
Bold |
⌘ I |
Italic |
⌘ U |
Underline |
⌘ Z / ⌘ ⇧ Z |
Undo / Redo |
# , ## , ### |
Heading 1 / 2 / 3 (markdown shortcut) |
> |
Blockquote |
- / * |
Bullet list |
1. |
Numbered list |
``` |
Code block |
$x$ |
Inline math (KaTeX) |
src/
├─ contexts/ # React contexts (documents, editor, global)
├─ extensions/ # Custom Tiptap extensions
│ ├─ SlashCommand.tsx # /-menu (14 block types)
│ ├─ Math.tsx # inline + block LaTeX (KaTeX)
│ ├─ Mention.tsx # @-page mentions
│ └─ MentionList.tsx # keyboard-navigable suggestion list
├─ hooks/ # useDebouncedCallback, useTheme, …
├─ lib/ # storage, markdown export, templates, types
├─ pages/
│ ├─ Editor/
│ │ ├─ index.tsx # thin EditorShell — composes everything
│ │ ├─ Sidebar.tsx # pages list, search, templates
│ │ ├─ Header.tsx # title, save state, cover, theme, export
│ │ ├─ MenuBar.tsx # Google Docs-style File/Edit/View/… menu
│ │ ├─ Toolbar.tsx # mark/heading/list/highlight/font/math
│ │ ├─ EditorMenus.tsx # composes the 3 in-editor surfaces:
│ │ ├─ BlockMenu.tsx # ⋮⋮ + ➕ drag handle and block menu
│ │ ├─ BubbleMenuBar.tsx # selection bubble (turn-into, link)
│ │ ├─ LinkPopover.tsx # inline link editor (replaces prompt)
│ │ ├─ CommandPalette.tsx # ⌘K palette
│ │ ├─ FindReplace.tsx # ⌘F find / ⌘⇧H replace
│ │ ├─ ShortcutsDialog.tsx # ⌘/ cheatsheet
│ │ ├─ CoverImageDialog.tsx # gallery + URL + upload cover picker
│ │ ├─ RightPanel.tsx # tabbed: Outline · Threads
│ │ ├─ Outline.tsx # auto-generated TOC
│ │ ├─ ThreadPanel.tsx # comments / threads UI
│ │ ├─ StatusBar.tsx # word/char count, reading time
│ │ ├─ ExportMenu.tsx # md / html / docx / clipboard / print
│ │ ├─ ThemeToggle.tsx # light / dark / system
│ │ ├─ constants.ts # colors, fonts, emojis
│ │ └─ getHeadings.ts # parse JSONContent → headings
│ └─ Error/ # 404
├─ components/ui/ # shadcn/ui primitives (button, dialog,
│ # dropdown-menu, popover, …)
└─ utils/TiptapExtension/
└─ ThreadExtension.tsx # custom Thread mark + unsetThreadById
Documents persist to localStorage under three namespaced keys:
tiptap-editor:documents:v1 → { [id]: Document }
tiptap-editor:active-doc:v1 → string (id)
tiptap-editor:theme:v1 → "light" | "dark" | "system"
- Drag-and-drop block reordering — shipped via the drag handle
- Inline link editor with URL + email auto-detection (no
prompt()dialogs) - Cover image picker with gallery / URL / upload
- Print-to-PDF (browser print)
- Optional cloud sync (BYO backend)
- Wiki-style
[[backlinks]] - Real-time collaboration via Yjs (self-hosted)
- Native PDF export (no print dialog)
- Mobile-friendly drag handle
Have an idea? Open an issue — PRs welcome.
Contributions, issues and feature requests are welcome.
- Fork the repo and create your branch from
master npm install,npm run dev- Run
npm run typecheck && npm run buildbefore submitting - Open a PR using the provided template
See CONTRIBUTING.md for the full guide.
MIT © Zanyuan Yang and contributors.
If this project helped you, ⭐ the repo to support it.
