cli

package
v1.7.0 Latest Latest
Warning

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

Go to latest
Published: Mar 15, 2026 License: GPL-3.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var BuildCmd = &cobra.Command{
	Use:   "build [docs-directory]",
	Short: "Build the static documentation site",
	Long: `Build generates a static HTML site from your markdown documentation.

By default, it looks for markdown files in the current directory and outputs
to the 'public' directory.`,
	Args: cobra.MaximumNArgs(1),
	RunE: runBuild,
}

BuildCmd represents the build command

View Source
var InitCmd = &cobra.Command{
	Use:   "init [directory]",
	Short: "Initialize a new documentation site",
	Long: `Initialize creates a new documentation site with example files.

This will create:
- config.yaml with site configuration
- Sample markdown files with frontmatter
- A basic directory structure

Optional features (use flags to enable):
- --with-toc: Custom navigation (TOC.md)
- --with-status: Status page structure
- --with-changelog: Changelog structure
- --with-openapi: OpenAPI specification example
- --full: Include all optional features`,
	Args: cobra.MaximumNArgs(1),
	RunE: runInit,
}

InitCmd represents the init command

View Source
var VersionCmd = &cobra.Command{
	Use:   "version",
	Short: "Print version information",
	Long: `Display the current version of MinimalDoc.

Use --check to check for updates from GitHub releases.`,
	RunE: runVersion,
}

VersionCmd represents the version command

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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