Skip to main content

Crate markless

Crate markless 

Source
Expand description

§Markless

A terminal markdown viewer with image support.

Markless renders markdown files in the terminal with:

  • Syntax-highlighted code blocks
  • Image support (Kitty, Sixel, half-block fallback)
  • Table of contents sidebar
  • File watching for live preview

§Architecture

Markless uses The Elm Architecture (TEA) pattern:

  • Model: Application state
  • Message: Events and actions
  • Update: Pure state transitions
  • View: Render to terminal

§Modules

  • app: Main application loop and state
  • document: Markdown parsing and rendering
  • ui: Terminal UI components
  • input: Event handling and keybindings
  • highlight: Syntax highlighting
  • image: Image loading and rendering
  • watcher: File watching
  • search: Search functionality

Modules§

app
Application state and main event loop.
config
document
Markdown document parsing and rendering.
highlight
Syntax highlighting for code blocks.
image
Image loading and rendering.
input
Input handling and keybindings.
perf
Lightweight performance instrumentation.
prelude
Re-export commonly used types
search
Search functionality.
ui
Terminal UI components.
watcher
File watching for live reload.