examples/

directory
v0.0.0-...-9a2d885 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2026 License: MIT

README

cli-web-docs examples

Example Demonstrates
render/ The basic case. Tiny CLI, single-page output. Start here.
multi-page/ Options.PerPage = true. One HTML file per visible subcommand.
custom-theme/ Operator-supplied Options.CSS to brand the output.
deep-tree/ Three-level nested command tree with realistic flag surface.

Each example is a runnable main.go and a short README. From the repo root:

go run ./examples/render ./site
open site/index.html

Pair with deploy/Caddyfile.example when you want a real host.

Directories

Path Synopsis
Command custom-theme demonstrates overriding the default stylesheet with operator-supplied CSS.
Command custom-theme demonstrates overriding the default stylesheet with operator-supplied CSS.
Command deep-tree renders documentation for a CLI with three levels of nested subcommands and a realistic flag surface.
Command deep-tree renders documentation for a CLI with three levels of nested subcommands and a realistic flag surface.
Command multi-page renders a small CLI as a multi-page documentation site: one HTML file per visible subcommand plus an index.html that lists the tree.
Command multi-page renders a small CLI as a multi-page documentation site: one HTML file per visible subcommand plus an index.html that lists the tree.
Command render is a tiny example that emits cli-web-docs HTML for a sample CLI into ./site.
Command render is a tiny example that emits cli-web-docs HTML for a sample CLI into ./site.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL