Discover Packages
github.com/coilysiren/cli-web-docs
examples
multi-page
command
Version:
v0.0.0-...-9a2d885
Opens a new window with list of versions in this module.
Published: May 16, 2026
License: MIT
Opens a new window with license information.
Imports: 5
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
README
¶
multi-page example
Same shape as render/ but with Options.PerPage = true. Each visible subcommand gets its own <name>.html; the index lists the tree.
$ go run ./examples/multi-page ./site
wrote ./site
$ ls site/
config-get.html config.html logs-since.html logs.html restart.html status.html stop.html
config-set.html index.html logs-tail.html ops.html start.html
Right for CLIs with more than ~10 commands or deep nesting where a single page becomes hard to navigate.
Expand ▾
Collapse ▴
Documentation
¶
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. Use when the command surface is large enough that a
single page becomes unwieldy to scroll.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.