coilysiren/cli-web-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3
No description
36 commits 1 branch 0 tags 106 KiB
  • Go 91.6%
  • Shell 5.1%
  • Makefile 3.3%
Find a file
Exact
Kai Siren 9a2d885054
Some checks are pending
ci / lint (push) Waiting to run
Details
ci / govulncheck (push) Waiting to run
Details
ci / test (push) Waiting to run
Details
ci / docs (push) Waiting to run
Details
codeql / analyze (go) (push) Waiting to run
Details
pages / build (push) Waiting to run
Details
pages / deploy (push) Blocked by required conditions
Details
chore(ci): remove codex-review-gate + undraft-and-poke-codex workflows 
closes #39
2026-05-16 15:42:13 -07:00
.agent-guard rename: update cross-repo refs after coilyco-ai to agentic-os-kai 2026-05-15 02:28:15 -07:00
.github chore(ci): remove codex-review-gate + undraft-and-poke-codex workflows 2026-05-16 15:42:13 -07:00
deploy Add deploy/Caddyfile.example + hosting note 2026-05-13 05:01:56 -07:00
docs chore: complete trifecta + re-enable catalog-doc-size + catalog-trifecta 2026-05-15 23:43:44 -07:00
examples Add three more cli-web-docs examples (multi-page, custom-theme, deep-tree) 2026-05-13 05:13:59 -07:00
layout Add godoc Example_* functions; remove UPSTREAM-CANDIDATES.md 2026-05-13 06:17:46 -07:00
scripts chore: adopt coilysiren/agentic-os v0.2.1 upstream-ref pre-commit suite 2026-05-15 23:33:52 -07:00
.gitignore Repository hygiene sweep: tier-A + CONTRIBUTING + godoc-current + auto-merge 2026-05-13 05:48:23 -07:00
.golangci.yaml Adopt coily's strict .golangci.yaml + pre-commit 2026-05-13 05:59:44 -07:00
.pre-commit-config.yaml chore: complete trifecta + re-enable catalog-doc-size + catalog-trifecta 2026-05-15 23:43:44 -07:00
AGENTS.md chore: complete trifecta + re-enable catalog-doc-size + catalog-trifecta 2026-05-15 23:43:44 -07:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2.1 as Code of Conduct 2026-05-13 05:31:36 -07:00
CONTRIBUTING.md Move .coily/coily.yaml to .agent-guard/agent-guard.yaml 2026-05-14 06:52:26 -07:00
example_test.go Add godoc Example_* functions; remove UPSTREAM-CANDIDATES.md 2026-05-13 06:17:46 -07:00
go.mod Bump the go-deps group across 1 directory with 2 updates (#21) 2026-05-13 17:22:46 +00:00
go.sum Bump the go-deps group across 1 directory with 2 updates (#21) 2026-05-13 17:22:46 +00:00
godoc-current.txt Repository hygiene sweep: tier-A + CONTRIBUTING + godoc-current + auto-merge 2026-05-13 05:48:23 -07:00
LICENSE Scaffold cli-web-docs: static HTML doc generator for urfave/cli v3 2026-05-13 04:29:12 -07:00
Makefile Repository hygiene sweep: tier-A + CONTRIBUTING + godoc-current + auto-merge 2026-05-13 05:48:23 -07:00
mkdocs-requirements.txt Add mkdocs (urfave palette) + docs CI verification 2026-05-13 05:28:44 -07:00
mkdocs.yml Repository hygiene sweep: tier-A + CONTRIBUTING + godoc-current + auto-merge 2026-05-13 05:48:23 -07:00
README.md chore: complete trifecta + re-enable catalog-doc-size + catalog-trifecta 2026-05-15 23:43:44 -07:00
SECURITY.md Add SECURITY.md (urfave shape) + nav and Support links 2026-05-13 05:36:33 -07:00
staticcheck.conf Adopt urfave-shaped README + trifecta + staticcheck.conf 2026-05-13 05:23:19 -07:00
webdocs.go Extract cli-web-docs/layout subpackage for cli-web-ops to share 2026-05-13 05:04:31 -07:00
webdocs_test.go Drop MetadataKeys from tests and example after refactor 2026-05-13 04:43:58 -07:00

README.md

cli-web-docs

Go Reference Go Report Card Tests status

cli-web-docs is a static HTML documentation generator for urfave/cli v3 command trees, featuring:

  • canonical Markdown from urfave/cli-docs, rendered to HTML by goldmark
  • single-page or per-command output via Options.PerPage
  • shared layout subpackage (also consumed by cli-web-ops) so docs + ops pages read as one site
  • dark-mode-aware default stylesheet, fully overridable via Options.CSS
  • pure Go, no JavaScript in the generated output
  • pairs with any static host (GitHub Pages, S3, Caddy via deploy/Caddyfile.example)

Documentation

See docs/FEATURES.md for a feature inventory and examples/ for four runnable demos (render, multi-page, custom-theme, deep-tree). Local dev verbs live in .agent-guard/agent-guard.yaml; agent-guard lint validates that against the Makefile.

Support

If you found a bug or have a feature request, create a new issue. Participation in this community is governed by the Code of Conduct. Security disclosures go through SECURITY.md.

Sibling repos in the cli-* family: cli-guard, cli-mcp, cli-web-ops.

License

See LICENSE.

See also

Cross-reference convention from coilysiren/agentic-os#59.