Documentation
¶
Index ¶
- func AddFlags(rootCmd *cobra.Command)
- func Manifest(filePath string) *api.Documentation
- func NewCommand(ctx context.Context, cancel context.CancelFunc) *cobra.Command
- func NewCompletionCmd() *cobra.Command
- func NewGenCmdDocs() *cobra.Command
- func NewReactor(ctx context.Context, options *Options, globalLinksCfg *api.Links) (*reactor.Reactor, error)
- func NewVersionCmd() *cobra.Command
- func WithHugo(reactorOptions *reactor.Options, o *Options)
- type Metering
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Manifest ¶
func Manifest(filePath string) *api.Documentation
Manifest creates documentation model from configration file
func NewCommand ¶
NewCommand creates a new root command and propagates the context and cancel function to its Run callback closure
func NewCompletionCmd ¶ added in v0.6.0
func NewGenCmdDocs ¶ added in v0.6.0
NewGenCmdDocs generates commands reference documentation in markdown format
func NewReactor ¶
func NewReactor(ctx context.Context, options *Options, globalLinksCfg *api.Links) (*reactor.Reactor, error)
NewReactor creates a Reactor from Options
func NewVersionCmd ¶
NewVersionCmd creates a version command printing the binary version as reported by the pkg/version/Version variable
Types ¶
type Metering ¶
type Metering struct {
Enabled bool
}
Metering encapsulates options for setting up client-side metering
type Options ¶
type Options struct {
MaxWorkersCount int
MinWorkersCount int
FailFast bool
DestinationPath string
ResourcesPath string
ResourceDownloadWorkersCount int
RewriteEmbedded bool
GitHubTokens map[string]string
Metering *Metering
GitHubInfoPath string
DryRunWriter io.Writer
Resolve bool
Hugo *hugo.Options
}
Options is the set of parameters for creating reactor objects
func NewOptions ¶
func NewOptions(f *cmdFlags) *Options
NewOptions creates an options object from flags
Source Files
Click to show internal directories.
Click to hide internal directories.