About Markbrowse

Markbrowse is a no-frills server designed to render markdown files as styled HTML. It provides a clean and efficient way to view markdown content directly in your browser. The tool features a collapsible sidebar file tree, enabling easy navigation through directories. It automatically renders .md files as HTML, using GitHub-flavored styling for both light and dark modes. If a directory contains a README.md or INDEX.md file, it will be used as the index page. Otherwise, a file listing will be displayed. The server also handles non-markdown files like images and PDFs by serving them as-is.

• Renders markdown files as HTML with GitHub-flavored styling (light + dark mode).

• Collapsible sidebar file tree for navigating the directory.

• Uses directories' README.md or INDEX.md as the index page.

• Falls back to a file listing when no index markdown is present.

• Serves non-markdown files as-is (images, PDFs, etc.).

• Supports Mermaid diagram rendering.

• Includes wiki-style [[link]] syntax with file-tree resolution.

• Supports GitHub/Obsidian-style admonition callouts (e.g., > [!NOTE]).

• Allows custom CSS for overriding the built-in stylesheet.

• Provides breadcrumb navigation on all pages.

• Designed for single binary, zero configuration deployment.

Installation can be done via go install github.com/anantshri/markbrowse@latest or by building from source. Usage involves simply running the markbrowse command, optionally specifying a directory or port. It supports flags for custom ports and custom CSS files.