attn

attn is a native markdown viewer tailored for users who prefer working directly from the terminal. With minimal setup, a single command is all it takes to launch a beautifully rendered markdown file in a dedicated window, eliminating the need for resource-heavy Electron applications.

Key Features

• Lightweight Design: At under 20MB, attn operates as a single binary that runs in the background and seamlessly opens in a native macOS window.
• Instant Live Reload: Changes to markdown files are reflected instantly as files are saved, without the hassle of refreshing.
• Interactive Checkboxes: Tasks marked with markdown checkboxes can be clicked to update the original file directly.
• Integrated Editor: A built-in editor can be activated with Cmd+E, featuring syntax highlighting, math support, and mermaid diagrams.
• Efficient Navigation: A file tree and fuzzy search capability allow for the easy browsing of projects, with fast loading of large directories.
• Tabbed Interface: Open multiple files in tabs within the same window, facilitating smooth project management changes.
• Inline Diagram Support: Render diagrams directly from fenced code blocks using Mermaid syntax.
• Media Compatibility: Native support for images, videos, and audio playback enhances markdown presentations.
• Customizable Themes: Enjoy a warm light theme by default and a cool dark mode option with --dark.
• Single Instance Operation: Multiple terminal sessions can run attn simultaneously, with work consolidated into a single window.

Quick Start

To launch attn from your current directory, simply type:

attn .

This command opens the current directory in a new tab, providing immediate access to your markdown content. Other usages support various functionalities including opening specific files and checking task progress.

Usage Examples

Here are several commands to get started:

attn README.md           # Open a specific file
attn ~/projects/myapp    # Open a project directory
attn --dark              # Activate dark mode
attn --status todo.md    # Display task completion status

Under the Hood

Built using Rust and Svelte 5, attn leverages the efficiency of compiled assets, ensuring rapid performance without relying on a web server or complex dependencies. The Svelte frontend is embedded directly into the Rust binary, allowing for a clean and cohesive user experience.

For developers interested in contributing to attn, an easy setup process is in place, including development commands that facilitate both Rust and frontend development in tandem.

attn stands out as a streamlined solution for markdown enthusiasts seeking a practical and efficient way to view and edit markdown files from the terminal.