Rust Markdown Early Preview

Your docs stack,
orchestrated.

MD Star is a document-native toolchain for engineers. One Rust parser core drives both the terminal reader and the desktop editor — markdown behavior stays consistent everywhere.

Quick install
$ git clone https://github.com/danieldear/mdstar && cd mdstar
$ cargo build --release -p mdstar-app
zsh — mdstar
v0.1-preview
  ~/docs  md README.md
# MD Star
Open-source developer document workbench.
## Install
$ cargo build --release -p mdstar-app
## Features
Terminal reader with table support
Desktop editor with autosave
Mermaid diagram rendering
mdstar-core
 ──▶ 
terminal
MD Star
Open-source developer document workbench.
Install
$ cargo build --release -p mdstar-app
Features
Terminal reader, desktop editor, and shared Rust parser core for consistent markdown behavior across interfaces.
Architecture
mdstar-core
terminal
desktop
| README.md | markdown mdstar-core · utf-8
Language Rust
License MIT / Apache-2.0
Interfaces Terminal + Desktop
Parser core mdstar-core
Status Early preview

Everything your docs
workflow needs

A compact, high-signal surface for writing and reviewing technical docs at speed.

Terminal Reader

md file.md delivers clean, consistent output with table handling and pager-friendly rendering.

cli tables pager

Desktop Editor

Autosave, outline navigation, file association, and instant visual confirmation in a native GPUI window.

gpui autosave outline

Shared Parser Core

One semantic Rust pipeline powers both interfaces — edge cases are fixed once, consistently everywhere.

rust ast

Mermaid Support

Diagram blocks render across both interfaces without custom user transforms or extra tooling.

diagrams mermaid

Workspace Navigation

Move through linked documents quickly with document-centric traversal patterns and backlink awareness.

links backlinks

Format Expansion

Roadmap includes YAML, JSON, and XML readers with the same ergonomics as the Markdown pipeline.

yaml json xml

One core, two surfaces

A single semantic parser with dedicated render layers for each interface.

mdstar-core
Rust parser & AST
render-terminal
ANSI renderer
render-html
HTML renderer
CLI md
terminal interface
mdstar-app
desktop window
CORE

The parser lives in mdstar-core and emits a typed AST. Neither render layer re-parses — they consume the same tree, so edge cases are fixed once.

TERMINAL

mdstar-render-terminal walks the AST and emits ANSI escape sequences. Tables, code fences, and Mermaid labels are all handled at this layer.

DESKTOP

mdstar-render-html feeds the GPUI-powered app. Outline navigation, autosave, and live preview all derive from the same parsed document model.

Up and running
in three steps

Clone, build, and choose terminal or desktop mode.

01 · CLONE

Get the source

$ git clone \
  https://github.com/danieldear/mdstar
$ cd mdstar
02 · BUILD

Compile with Cargo

$ cargo build \
  --release \
  -p mdstar-app
03 · RUN

Choose your interface

# terminal reader
$ ./target/release/md README.md

# desktop app
$ cargo run -p mdstar-app \
  -- --app

What's next

Near-term priorities to harden the stack for broader contribution.

Structured Parsers

Add YAML, JSON, and XML readers with quick section jumping and the same ergonomics as the Markdown pipeline.

01 format layers

Graph Navigation

Improve backlinks, traversal speed, and multi-file movement across linked document graphs.

02 graph

Release Maturity

Stabilize crate naming, packaging, and release automation for a smooth contributor onboarding flow.

03 contrib