servef

command module

v0.1.0 Latest Latest Go to latest Published: Sep 13, 2026 License: MIT Imports: 3 Imported by: 0

Details

Serve and browse Markdown files from a local directory.

brew install flexdinesh/tap/servef

Requires Go 1.24 or later.

go install github.com/flexdinesh/servef@latest

See the release guide for publishing details.

Serve the current directory:

servef .

Or serve another directory:

servef path/to/markdown

Requires Node.js 26 and pnpm 11.

go mod download
pnpm install
pnpm dev

Run checks:

go test ./...
pnpm test:web
pnpm test:release
pnpm typecheck
pnpm exec playwright install --with-deps chromium
pnpm test:browser

Build the embedded frontend:

pnpm build:web

There is no documentation for this package.

Path	Synopsis
cmd Package cmd defines the servef command-line interface.	Package cmd defines the servef command-line interface.
internal
browser Package browser opens URLs and other browser-compatible targets using the operating system's default handler.	Package browser opens URLs and other browser-compatible targets using the operating system's default handler.
features Package features defines experimental server and browser behavior.	Package features defines experimental server and browser behavior.
files Package files discovers Markdown documents and safely resolves indexed paths.	Package files discovers Markdown documents and safely resolves indexed paths.
version Package version reports servef build metadata.	Package version reports servef build metadata.
web Package web serves a live Markdown index and rendered documents.	Package web serves a live Markdown index and rendered documents.