Skip to content

efecanbasoz/markdowned

Repository files navigation

Markdowned

The fastest lightweight markdown editor for Linux, macOS, and Windows.

License: Apache-2.0 Rust Tauri Platforms Version

Built with Tauri, Svelte 5, and CodeMirror 6. No Electron, no bloat.


Table of Contents


Features

  • Multi-tab editing — Open multiple files with independent cursor, scroll, and dirty state
  • Split view — Edit and preview side by side (horizontal or vertical)
  • Live preview — GitHub-flavored Markdown with syntax-highlighted code blocks
  • Workspace search — Search across all files with Ctrl+Shift+F
  • AI completion — Inline suggestions from Ollama, OpenAI, Google, Anthropic, or custom providers
  • Auto-completion — Optional debounced suggestions as you type
  • Command palette — Quick file access with Ctrl+K
  • Dark & Light themes — Toggle with Ctrl+Shift+T
  • Secure credentials — API keys stored in OS keychain (GNOME Keyring / macOS Keychain)
  • File watcher — Sidebar auto-updates on external file changes
  • Frontmatter support — YAML metadata displayed as compact badge in preview
  • Lightweight — ~50MB memory, <200ms startup, <10MB binary

Installation

Download

Grab the latest release from GitHub Releases:

  • Linux: .deb or .AppImage
  • macOS: .dmg (ARM and Intel)
  • Windows: .msi or .exe

Build from Source

# Prerequisites: Node.js 20+, Rust 1.70+ # Linux: sudo apt install libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev libsoup-3.0-dev libgtk-3-dev libsecret-1-dev git clone https://github.com/efecanbasoz/markdowned.git cd markdowned npm install npx tauri build

Usage

Keyboard Shortcuts

Shortcut Action
Ctrl+O Open workspace
Ctrl+S Save file
Ctrl+W Close tab
Ctrl+K Command palette
Ctrl+Shift+F Search workspace
Ctrl+\ Cycle view mode (Edit → Split → Preview)
Ctrl+Shift+P Toggle Edit/Preview
Ctrl+Shift+T Toggle Dark/Light theme
Ctrl+Shift+E Toggle sidebar
Ctrl+Enter AI completion
Tab Accept suggestion
Esc Dismiss suggestion
Ctrl+B Bold
Ctrl+I Italic
Ctrl+Shift+K Insert link
Ctrl+, Settings

AI Completion Setup

Open Settings (Ctrl+,) to configure your AI provider:

Provider API Key Required Default Model
Ollama (local) No llama3.2
Google Yes gemini-2.0-flash
OpenAI Yes gpt-4o-mini
Anthropic Yes claude-3-5-haiku-latest
Custom Optional User-defined

API keys are stored securely in your OS keychain.


Configuration

Settings stored at ~/.config/markdowned/config.toml:

theme = "dark" split_direction = "horizontal" [completion] provider = "ollama" model = "" auto_completion = false

Tech Stack


Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Build with npx tauri build to verify
  4. Commit your changes
  5. Push to the branch and open a Pull Request

License

Apache-2.0

About

The fastest lightweight markdown editor for Linux and macOS

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors