Skip to content

Repository files navigation

servef

Serve and browse Markdown files from a local directory.

Features

  • Render Markdown content and local images
  • Switch each open document between preview and read-only source
  • Navigate files in a compact, resizable tree
  • Keep visited documents in an editor-style tab bar
  • Show document details and supported process CPU/RAM in a status line
  • Switch between system, light, dark, and editor palettes
  • Render Mermaid diagrams with Excalidraw

Install

Homebrew

brew install flexdinesh/tap/servef

Go

Requires Go 1.24 or later.

Latest stable release:

go install github.com/flexdinesh/servef@latest

Specific stable version:

go install github.com/flexdinesh/servef@v0.1.3

All Go installs include the embedded frontend; Node.js and pnpm are not required.

Usage

Serve the current directory:

servef .

Or serve another directory:

servef path/to/markdown

Without --port, servef uses the first free port from 7971 through 7980. Use --host to bind a specific IP address or --port to select an exact port. If the range is full, servef can stop all verified instances after confirmation.

See all options:

servef --help

About

Serve all markdown files in a dir over a readonly web editor-like interface

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages