multi-page

command
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 Imports: 5 Imported by: 0

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.

Documentation

Overview

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.

Jump to

Keyboard shortcuts

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