docsummary

command
v1.0.0-alpha.7 Latest Latest
Warning

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

Go to latest
Published: Oct 9, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Command docsummary splices the SUMMARY.md fragment a `pulse docs export` writes into the book's own SUMMARY.md, between the docgen.BookSpanBegin / BookSpanEnd lines, prefixing every path with the export directory. `make docs` runs it after the export; it is a development tool only (never imported, never shipped).

go run ./internal/tools/docsummary -book docs/src/SUMMARY.md \
    -fragment docs/src/guide/SUMMARY.md -prefix guide/

The book file is rewritten only when the splice changes it.

Jump to

Keyboard shortcuts

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