Skip to content

MARKDOWN SOURCE

Raw
# Markdown Editor

A focused, native Markdown editor built with Rust, egui/eframe, and pulldown-cmark. It runs as a desktop application and does not use a webview or browser.

## Setup and run

Rust `1.98.1` is pinned in `mise.toml`. With [mise](https://mise.jdx.dev/) installed:

```sh
mise install
mise run install
mise run run
```

`mise run install` installs the pinned toolchain and fetches the exact crate versions in `Cargo.lock`. You can also run the application directly with `cargo run --locked` after installation.

## Controls

- **New**, **Open…**, **Save**, and **Save as…** are available in the toolbar. Open/save dialogs use the desktop's native file-dialog portal where available.
- `Ctrl`/`⌘` + `N`, `O`, and `S` create, open, and save documents.
- Edit in the left pane; the live preview appears alongside it and can be toggled from the toolbar.
- The footer shows the current file, save state, and operation status. The toolbar shows word and character counts.

## Markdown support

The preview covers headings, paragraphs and line breaks, bold, italic, strikethrough, inline code, fenced and indented code blocks, ordered and unordered lists, task-list markers, blockquotes, and horizontal rules. Links and raw HTML are not rendered as active content. Editing and file I/O preserve the Markdown source as UTF-8.

## Checks

```sh
mise run check
```

This runs the unit tests and Clippy over all targets with both `all` and `pedantic` lints enabled. The project contains logic tests for preview parsing and UTF-8 file round-tripping.

Markdown Editor

A focused, native Markdown editor built with Rust, egui/eframe, and pulldown-cmark. It runs as a desktop application and does not use a webview or browser.

Setup and run

Rust 1.98.1 is pinned in mise.toml. With mise installed:

mise install
mise run install
mise run run

mise run install installs the pinned toolchain and fetches the exact crate versions in Cargo.lock. You can also run the application directly with cargo run --locked after installation.

Controls

  • New, Open…, Save, and Save as… are available in the toolbar. Open/save dialogs use the desktop's native file-dialog portal where available.
  • Ctrl/⌘ + N, O, and S create, open, and save documents.
  • Edit in the left pane; the live preview appears alongside it and can be toggled from the toolbar.
  • The footer shows the current file, save state, and operation status. The toolbar shows word and character counts.

Markdown support

The preview covers headings, paragraphs and line breaks, bold, italic, strikethrough, inline code, fenced and indented code blocks, ordered and unordered lists, task-list markers, blockquotes, and horizontal rules. Links and raw HTML are not rendered as active content. Editing and file I/O preserve the Markdown source as UTF-8.

Checks

mise run check

This runs the unit tests and Clippy over all targets with both all and pedantic lints enabled. The project contains logic tests for preview parsing and UTF-8 file round-tripping.