Skip to content

A minimal, distraction-free markdown editor built with Tauri, React, and TypeScript

License

Notifications You must be signed in to change notification settings

Razee4315/MarkLite

Repository files navigation

MarkLite Logo

MarkLite

A minimal, distraction-free markdown editor built with Tauri, React, and TypeScript.

Why MarkLite?

As a developer, I frequently work with markdown files for documentation, notes, and project READMEs. The frustration of opening .md files in Notepad or basic text editors, only to see raw, unformatted text with all the symbols and syntax cluttering the content, inspired me to build MarkLite.

I wanted a simple, lightweight solution that renders markdown beautifully while still giving me quick access to the raw code when I need to edit. No bloated features, no complex setup, just a clean interface that lets me focus on my content.

Screenshots

Themes

Dark Theme Light Theme
Dark Theme Light Theme

Paper Theme
Paper Theme

Features in Action

Code Mode
Code Mode with Syntax Highlighting

File Explorer
File Explorer Panel

Table of Contents
Table of Contents Panel

Features

  • Clean Interface - Minimal UI that stays out of your way
  • Live Preview - Switch between reader and code modes instantly with Ctrl+E
  • Syntax Highlighting - Full markdown syntax highlighting in the editor
  • Three Themes - Dark, Light, and Paper themes to match your preference
  • Five Fonts - Inter, Merriweather, Lora, Source Serif, Fira Sans
  • Adjustable Font Size - Small, Medium, and Large options
  • File Explorer - Quick access to markdown files in the current directory
  • Table of Contents - Navigate large documents easily
  • Native Performance - Built with Tauri for a lightweight, fast experience
  • Cross-Platform - Windows, macOS, and Linux support

Installation

Download the latest release from the Releases page.

Available Formats

  • Windows: .msi installer or .exe portable
  • Linux: .deb, .rpm, or .AppImage

Development

Prerequisites

Setup

# Clone the repository
git clone https://github.com/Razee4315/MarkLite.git
cd MarkLite

# Install dependencies
bun install

# Run in development mode
bun run tauri dev

# Build for production
bun run tauri build

Keyboard Shortcuts

Action Shortcut
Open File Ctrl+O
Save File Ctrl+S
Toggle Mode Ctrl+E

Tech Stack

  • Frontend: React, TypeScript, Tailwind CSS
  • Backend: Rust, Tauri v2
  • Build: Vite

Contributing

Contributions are welcome. Please read the Contributing Guidelines and Code of Conduct before submitting a pull request.

Author

Saqlain Abbas
Email: saqlainrazee@gmail.com
GitHub: @Razee4315 Linkedin: @saqlain.razee

License

This project is source available with restricted commercial use:

  • Personal use - Free to use, copy, and modify
  • Commercial use - Requires written permission from the author

See the LICENSE file for full details.