docgen

package
v0.0.21 Latest Latest
Warning

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

Go to latest
Published: Aug 21, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DocFlags = []cli.Flag{
	MarkdownEcho.AsCliFlag(env.WithBoolAction(func(context *cli.Context, b bool) error {
		if b {
			args := slices.Clone(os.Args)
			cwd, err := os.Getwd()
			if err == nil && len(args) > 0 {
				var s string
				s, err = filepath.Rel(cwd, args[0])
				if err == nil {
					args[0] = "./" + s
				}
			}
			return md.NewMarkdown(os.Stdout).CodeBlocks(md.SyntaxHighlightShell,
				strings.Join(args, " ")).LF().Build()
		}
		return nil
	})),
}
View Source
var MarkdownEcho = env.NewBool(env.Spec{
	Name:        "BOXER_MARKDOWN_ECHO",
	Description: "echo os.Args as a markdown shell code block on startup (experimental)",
	Category:    env.CategoryDocgen,
	CliFlagName: "markdownEcho",
})
View Source
var PackageProps = packageprops.Props{
	WASMWASI:         packageprops.WASMBlocked,
	WASMJS:           packageprops.WASMBlocked,
	WASMFreestanding: packageprops.WASMBlocked,
}

PackageProps records this package's curated properties (ADR-0080). Seeded by `boxer code analysis golang wasmsurvey props generate`; curate by hand. The same group's `props verify` reconciles it.

Functions

func NewDocCli

func NewDocCli() *cli.Command

Types

This section is empty.

Jump to

Keyboard shortcuts

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