mdfocus

mdfocus - A Sleek Markdown Reader for Localhost

Overview
mdfocus is designed to provide a distraction-free reading experience for Markdown files, making it particularly useful in an era dominated by LLM-generated content. This tool allows users to effortlessly read Markdown documents organized in folders without requiring any build steps or configuration, ensuring a seamless experience. Simply direct mdfocus to any folder containing Markdown files, and it handles the rest.

Key Features

• Focus Mode: Enjoy a clean and minimal interface that highlights the content without distractions.
• Reading Status: Track your progress through files with color-coded markers: 🟡 for in-progress, 🟢 for completed, and 🔴 for unread.
• Table of Contents: Automatically generated from document headings for easy navigation.
• Live Reloading: Any changes made to your Markdown files are instantly reflected in the viewer.
• Syntax Highlighting: Beautifully formatted code blocks supporting over 100 programming languages.
• Mermaid Diagrams: Effortlessly include flowcharts, sequence diagrams, ERDs, and more directly within your documents.
• Image and File Serving: Easily display images and linked files from your Markdown directory.
• Scroll Memory: Retains your scroll position in both the tree view and content view for enhanced user experience.
• Dark Mode: An easy-on-the-eyes interface for both day and night reading.

Usage
Initiate mdfocus with a simple command to start exploring your Markdown files:

npx mdfocus ~/notes

Once running, access your Markdown files by navigating to http://localhost:4242.

Development and Setup
For those interested in contributing to mdfocus, it requires the following prerequisites:

• Bun for JavaScript runtime and package management.
• Just for command execution.
• Node.js for build tooling.

Clone the repository and initialize the development server with these commands:

git clone https://github.com/tzador/mdfocus.git
cd mdfocus
bun install
just dev ./samples

Conclusion
mdfocus is an ideal solution for those looking to consume Markdown content effortlessly and without distractions. It stands out in the realm of Markdown readers, especially for handling content generated by language models, making it a valuable tool for professionals, researchers, and anyone who values efficient reading.