Skip to content
/ bugbook Public

Combining everything I like found in Notion, Obsidian, and AI for the ultimate personal text editor.

Notifications You must be signed in to change notification settings

max4c/bugbook

Repository files navigation

Bugbook

A local-first note-taking app built with Tauri and React. Notes are stored as plain markdown files on your filesystem.

Features

  • Markdown-based: Notes are plain .md files you can edit anywhere
  • Wiki-links: Link between notes with [[Page Name]] syntax
  • Databases: Create Notion-style databases embedded in your notes
  • Slash commands: Type / for quick formatting and block insertion
  • Tabs & sidebar: Multi-tab editing with file tree navigation
  • Command palette: Quick access to commands with Cmd+K
  • AI note editing: Edit the active note via local codex or claude CLI flows
  • Chat with notes: Ask questions across all notes in your workspace
  • Settings + shortcuts reference: Built-in settings view with keyboard reference
  • In-note find: Search current note content with match navigation
  • Sub-pages: Organize notes hierarchically
  • Light/dark theme: Follows system preference or manual toggle
  • Cross-platform: macOS, Windows, Linux (iOS in progress)

AI Editing Prerequisites

AI editing is local-first and uses CLI tools on your machine:

  • Install codex and/or claude
  • Authenticate those tools normally in your shell
  • Open Settings → AI to verify availability and choose default engine

Tech Stack

  • Frontend: React, TypeScript, TipTap editor, Mantine UI
  • Backend: Tauri 2.0 (Rust)
  • Storage: Local filesystem (markdown files)

Development

# Install dependencies
npm install

# Run in development mode
npm run tauri dev

# Build for production
npm run tauri build

Project Structure

src/
├── components/       # React components
│   ├── Editor/       # TipTap editor and related
│   ├── Database/     # Database views and editing
│   ├── Sidebar/      # File tree navigation
│   └── ...
├── extensions/       # TipTap extensions (wiki links, database embeds)
├── hooks/            # React hooks (file system, theme, etc.)
├── lib/              # Utilities (markdown parsing, editor config)
└── types/            # TypeScript type definitions

src-tauri/            # Rust backend (Tauri)

Keyboard Shortcuts

Shortcut Action
Cmd+N New note
Cmd+P / Cmd+K Quick open / Command palette
Cmd+T New tab
Cmd+W Close tab
Cmd+. Toggle sidebar
Cmd+F Find in current note
Cmd+I Ask AI
Cmd+Shift+L Toggle theme
Cmd+, Open settings
Cmd+/ Open shortcuts reference
/ Slash commands (in editor)
[[ Link to page (in editor)

About

Combining everything I like found in Notion, Obsidian, and AI for the ultimate personal text editor.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •