Skip to content

ai-screams/BoltDown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

159 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โšก BoltDown

Lightning-fast Markdown editor. 10x smaller than Electron apps.


๐Ÿค” Why BoltDown?

Electron apps are gas-guzzling SUVs. BoltDown is a Tesla.

โšก BoltDown Typora Obsidian
Size ~7 MB ๐Ÿชถ ~120 MB ~100 MB
Memory 50-100 MB ๐Ÿ’จ 200-500 MB 300-400 MB
Startup < 1 second ๐Ÿš€ 2-3 seconds 2-3 seconds
Price Free ๐ŸŽ‰ $14.99 Free
Engine Tauri (Rust) ๐Ÿฆ€ Electron Electron

BoltDown is a native desktop Markdown editor built with Tauri 2.0 and Rust. It launches instantly, stays light on memory, and gives you a complete writing experience โ€” without the Electron baggage.


โœจ Features

โœ๏ธ Writing Experience

  • Live Preview โ€” WYSIWYG editing that renders Markdown as you type. Bold, italic, headings, links, and images display inline with real formatting.
  • Split View โ€” Source code on the left, rendered preview on the right, with synchronized scrolling.
  • Source Mode โ€” Clean, distraction-free code editing when you want full control.
  • Zen Mode ๐Ÿง˜ โ€” Full-screen writing with nothing but your text. Press Escape to return.

๐Ÿ“ฆ Rich Content

  • Math ๐Ÿงฎ โ€” LaTeX equations with KaTeX. Inline $E=mc^2$ and block $$...$$ with real-time rendering.
  • Diagrams ๐Ÿ“Š โ€” Mermaid flowcharts, sequence diagrams, Gantt charts, and more โ€” rendered live in the editor.
  • Code Blocks ๐Ÿ’ป โ€” Syntax highlighting for 100+ languages with language badges, autocomplete, and boundary navigation.
  • Tables ๐Ÿ“‹ โ€” Interactive WYSIWYG table editing. Add/remove rows and columns, set alignment, resize โ€” all in place.
  • Table of Contents ๐Ÿ—‚๏ธ โ€” Type [TOC] anywhere to generate a linked table of contents from your headings.

๐Ÿ› ๏ธ Editor Features

  • Tabs โ€” Work with multiple files at once. Drag, rename, close โ€” with unsaved change indicators.
  • File Tree ๐Ÿ“‚ โ€” Sidebar with folder navigation, file icons by type, and context menus for file operations.
  • Outline Panel โ€” Navigate your document by heading structure.
  • Find & Replace ๐Ÿ” โ€” Full-featured search with regex, case sensitivity, whole word matching, and live match counter.
  • Focus Mode ๐ŸŽฏ โ€” Dims all lines except where your cursor is, helping you concentrate on the current paragraph.
  • Typewriter Mode โŒจ๏ธ โ€” Keeps your active line vertically centered as you type.
  • Vim Mode ๐Ÿ–ฅ๏ธ โ€” Optional vim keybindings with :w, :q, :wq commands. CJK users get automatic input method switching (Normal โ†’ English, Insert โ†’ restore previous).
  • Auto-Save ๐Ÿ’พ โ€” Configurable automatic saving so you never lose work.
  • Spellcheck โœ๏ธ โ€” Native spellcheck with underline indicators.
  • Export ๐Ÿ“ค โ€” Save your work as HTML or PDF.

๐ŸŽจ Customization

  • 6 Built-in Themes โ€” Bolt, Sepia, Nord, Contrast, Meadow, and Vivid โ€” each with light and dark variants.
  • Custom CSS โ€” Write your own CSS overrides with a built-in editor, live preview, and reference guide.
  • Editor Settings โ€” Font family, font size, line height, tab size, line numbers, and more.

โ™ฟ Accessibility

  • Full keyboard navigation throughout the app
  • WAI-ARIA compliant tabs, menus, dialogs, and form controls
  • Screen reader support with live regions for status updates
  • prefers-reduced-motion respected

๐Ÿ“ฅ Install

๐ŸŽ macOS

Download the .dmg file from the latest release, open it, and drag BoltDown to your Applications folder.

๐Ÿ’ก Apple Silicon and Intel โ€” We provide separate builds for each architecture for the best native performance.

Caution

"BoltDown is damaged and can't be opened" โ€” The app is not yet code-signed with an Apple Developer certificate. macOS Gatekeeper blocks unsigned apps by default. To open BoltDown, run this in Terminal after installing:

xattr -cr /Applications/BoltDown.app

We plan to enroll in the Apple Developer Program soon to provide properly signed and notarized builds.

๐ŸชŸ Windows

Download the .msi installer from the latest release and run it.

Caution

Windows SmartScreen warning โ€” The app is not yet code-signed. When you see "Windows protected your PC", click "More info" โ†’ "Run anyway" to proceed. Code signing is planned for a future release.

๐Ÿง Linux

Download the .AppImage or .deb package from the latest release.

# Debian / Ubuntu
sudo dpkg -i boltdown_*.deb

# AppImage (any distro)
chmod +x BoltDown_*.AppImage
./BoltDown_*.AppImage

โŒจ๏ธ Keyboard Shortcuts

Action macOS Windows/Linux
New tab Cmd+N Ctrl+N
Open file Cmd+O Ctrl+O
Save Cmd+S Ctrl+S
Save as Cmd+Shift+S Ctrl+Shift+S
Find Cmd+F Ctrl+F
Find & Replace Cmd+H Ctrl+H
Cycle mode Cmd+\ Ctrl+\
Zen mode Cmd+Shift+Z Ctrl+Shift+Z
Toggle sidebar Cmd+Shift+E Ctrl+Shift+E
Settings Cmd+, Ctrl+,
Shortcuts help Cmd+Shift+/ Ctrl+Shift+/

๐Ÿง‘โ€๐Ÿ’ป Development

Prerequisites

Setup

git clone https://github.com/ai-screams/BoltDown.git
cd BoltDown
npm install
npm run tauri:dev

Build

# Build for your current platform
npm run tauri:build

# macOS DMG only
npm run tauri build -- --bundles dmg

# Validate before committing
npm run validate

Project Structure

src/              โš›๏ธ  React frontend (components, stores, hooks)
src-tauri/        ๐Ÿฆ€  Rust backend (file ops, settings, IME)
.docs/            ๐Ÿ“š  Documentation (ADR, PRD, planning)
tests/            ๐Ÿงช  E2E tests (Playwright)

Quality Gates

Check Command
Type check npx tsc --noEmit
Lint npx eslint src/
Unit tests npm run test:run
Frontend build npx vite build
Rust check cd src-tauri && cargo check
Dead code npm run knip

๐Ÿ—๏ธ Tech Stack

Layer Technology
๐Ÿ–ฅ๏ธ Shell Tauri 2.0 (Rust)
โš›๏ธ UI React 19 + TypeScript
โœ๏ธ Editor CodeMirror 6
๐Ÿ“ Markdown markdown-it + KaTeX + Mermaid + Prism.js
๐Ÿ—ƒ๏ธ State Zustand
๐ŸŽจ Styling Tailwind CSS
๐Ÿ–ฅ๏ธ Vim @replit/codemirror-vim

๐Ÿค Contributing

We welcome contributions! Please read our Contributing Guide for details on:

  • Development setup and workflow
  • Code style and architecture guidelines
  • Commit message conventions (Conventional Commits with 25 scopes)
  • Pull request requirements (squash merge, 1 PR = 1 purpose)
  • Testing instructions

Pre-commit hooks (Husky + lint-staged + commitlint) enforce quality automatically.


๐Ÿ“„ License

MIT โ€” Copyright 2026 PignuAnte (Ai-Scream)


โšก Built with Rust. Powered by open source. โšก

Made by PignuAnte @ Ai-Scream

GitHub ยท Releases ยท Issues

About

โšก Lightning-fast Markdown editor built with Tauri 2.0 + React 19. ๐Ÿฆ€ 10x smaller than Electron apps.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors