Skip to content

Latest commit

 

History

2,236 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkdownRS

MarkdownRS is a focused Markdown editor. It prioritises performance and a clean, minimal UI while still being fully featured for technical and general users.

License GitHub Issues GitHub Stars

screenshot 1

The only Markdown editor you need? Many people are saying so.

Features

Editing & Authoring

  • Markdown Flavors: GFM (GitHub Flavored Markdown) and CommonMark.
  • Smart Formatting: Auto-Markdown formatting for standards=compliant, consistent output.
  • Text Operations: Sort lines, trim whitespace, change case, etc.
  • Rendered Mode: Edit in rendered or raw Markdown mode.
  • Find & Replace: Across all open documents.

Performance & Reliability

  • Fast, Low Resource Use: Built with a Rust backend for instant startup and smooth editing.
  • Auto-Save: Session persistence with hot-exit support — never lose your work.

Preview & Rendering

  • Live Preview: Split view with smooth, bi-directional synchronized scrolling.
  • Diagrams (Mermaid): Render flowcharts, sequence diagrams, and more with Mermaid.js.
  • Math (KaTeX): Render math in the preview with KaTeX delimiters:
Style Syntax
Inline $...$, \(...\)
Display $$...$$, \[...\], ```math fence

Math is rendered to HTML via KaTeX renderToString and cached by expression hash, so unchanged expressions are never re-rendered. KaTeX CSS and fonts are bundled for offline use.

Diagrams (Mermaid)

Flowcharts, sequence diagrams, and other diagrams render in the preview from ```mermaid fenced blocks. Mermaid is lazy-loaded only when a diagram is present and rendered diagrams are cached by content hash, so unchanged diagrams are never re-rendered.

Documents & Organisation

  • Multi-Tab: Work on multiple documents simultaneously, pin them, bookmark them.
  • File Tree: Sidebar file tree for browsing and opening files.
  • Bookmark System: Bookmark and tag local documents with instant filter search.
  • New File Template: Create new files from a configurable template.

Customisation

  • Command Palette: Efficient navigation with command palette (Ctrl+Shift+P).
  • Keyboard Shortcuts: Customise any command's shortcut as you want.
  • Themes: Multiple built-in light and dark themes, plus custom themes.

Export

  • Export your documents to PDF, PNG, WEBP, or HTML.

Markdown Linting / Formatting

The embedded rumdl lints and formats Markdown content; rules can be configured with the built-in editor.

rumdl config files - .rumdl.toml or rumdl.toml - can be placed at project or home folder levels. If neither exists, the built-in defaults are used.

Grammar Checking

The Harper Grammar Check is optional and its rules can be edited in settings.toml:

[harperLinters]
OxfordComma = false      # disable a rule
LongSentences = true     # force a rule on

Installation

Prebuilt Linux and Windows binaries are available on the GitHub Releases page.

Linux

AppImage

chmod +x MarkdownRS_*.AppImage
./MarkdownRS_*.AppImage

To add it to your application menu and file associations, use AppImageLauncher or GearLever.

Debian / Ubuntu

sudo apt install ./MarkdownRS_*.deb

Fedora / RHEL

sudo dnf install ./MarkdownRS-*.rpm

Arch / CachyOS

Install the prebuilt package from the latest release:

sudo pacman -U MarkdownRS-*.pkg.tar.zst

Or build and install locally from the included PKGBUILD:

bun install
bun run package

Windows

Download and run the NSIS .exe installer from the latest release.

Build from Source

See Development. You'll need Rust, bun, and the platform Tauri prerequisites.


Code / Dev Stack

Development

bun install          # Install dependencies
bun run check        # Full check: Svelte types, Biome lint, and cargo check + clippy
bun run format       # Format code with Biome + 'cargo fmt'
bun run update       # Update packages + crates
bun run dev          # Start dev server / HMR
bun run preview      # Preview the production build
bunx tauri build     # Build distributable bundles (.deb, .rpm, .AppImage, NSIS)
bun run clean        # Remove build artifacts, target, and node_modules
bun run package      # build and install

Contributing

Pull Requests and bug reports / feature requests are welcomed.

License

GNU General Public License v3.

About

Markdown editor for desktop. Fast, feature-packed, cross-platform.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages