leaf — Terminal Markdown previewer — GUI like experience.

Pitch

Description

Comments

About this project

leaf provides a user-friendly, GUI-like experience for previewing Markdown right in the terminal. Compatible with multiple operating systems, it streamlines the process of viewing and editing Markdown files, ensuring real-time updates and easy installation. Ideal for developers and content creators looking to enhance their workflow.

leaf is a terminal-based Markdown previewer that delivers a graphical user interface (GUI) experience directly in the terminal. Designed for simplicity and efficiency, leaf is suitable for various platforms, including macOS, Linux, Android, Windows, and Termux, providing users with a powerful tool for real-time Markdown editing and viewing.

Key Features

Watch Mode: Automatically reloads previews every 250 milliseconds, enhancing the editing experience with instant feedback.
Syntax Highlighting: Supports a variety of programming languages like Python, C++, JSON, and more, ensuring cleaner code representation.
Table of Contents: Features an interactive sidebar that tracks active sections, allowing for easy navigation through documents.
LaTeX Support: Renders inline mathematical equations and formula blocks, making it ideal for technical documentation.
Fuzzy Picker: Quickly access Markdown files without having to specify a file directly, making document management seamless.
Runtime Theme Preview: Easily switch between themes with real-time visualization.
Help Popups: Get instant guidance on keybindings and functionalities within the application.

Usage

leaf can be initiated with simple commands, allowing users to:

Open and edit Markdown files:
```
leaf TESTING.md
```
Enable watch mode for live reloading:
```
leaf --watch TESTING.md
```
Stream Markdown from other CLI tools:
```
claude "explain Rust lifetimes" | leaf
```

Enhanced Document Management

Developers can utilize the built-in keybindings to navigate documents effectively, facilitating tasks such as scrolling, text selection, and finding specific content with ease.

Roadmap

The project is continuously evolving with plans for new features such as improved search capabilities and code block enhancements. This ensures that leaf remains a relevant and powerful tool for anyone working with Markdown content.

Getting Started

To integrate leaf into your workflow, install it using:

For macOS / Linux / Android / Termux:

curl -fsSL https://raw.githubusercontent.com/RivoLink/leaf/main/scripts/install.sh | sh

For Windows:

irm https://raw.githubusercontent.com/RivoLink/leaf/main/scripts/install.ps1 | iex

"leaf" not only enhances Markdown writing but also optimizes documentation processes in a terminal environment, making it an essential tool for developers and technical writers alike.