README
¶
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.
go install github.com/flexdinesh/servef@latest
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
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
control
Package control coordinates graceful shutdown between servef processes.
|
Package control coordinates graceful shutdown between servef processes. |
|
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. |
|
tools
|
|
|
release-version
command
|
Click to show internal directories.
Click to hide internal directories.