typreadme

package
v0.8.17 Latest Latest
Warning

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

 Go to latest Published: Jan 20, 2020 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommandInfo added in v0.8.15 

type CommandInfo struct {
	Snippet string
	Usage   string
}

CommandInfo is command information

type CommandInfos added in v0.8.15 

type CommandInfos []*CommandInfo

CommandInfos is collection of command information

func (*CommandInfos) Append added in v0.8.15 

func (c *CommandInfos) Append(detail *CommandInfo)

Append command info

type ConfigInfo added in v0.8.15 

type ConfigInfo struct {
	Name     string
	Type     string
	Default  string
	Required string
}

ConfigInfo is configuration information

type ConfigInfos added in v0.8.15 

type ConfigInfos []*ConfigInfo

ConfigInfos is collection of configuration information

func (*ConfigInfos) Append added in v0.8.15 

func (c *ConfigInfos) Append(detail *ConfigInfo)

Append config info

type Module added in v0.8.10 

type Module struct {
	Target   string
	Template string
}

Module of readme

func New added in v0.8.15 

func New() *Module

New readme module

func (*Module) BuildCommands added in v0.8.10 

func (m *Module) BuildCommands(ctx *typcore.BuildContext) []*cli.Command

BuildCommands to be shown in BuildTool

func (*Module) WithTarget added in v0.8.15 

func (m *Module) WithTarget(target string) *Module

WithTarget to set target

func (*Module) WithTemplate added in v0.8.15 

func (m *Module) WithTemplate(template string) *Module

WithTemplate to set template

type ReadmeObject added in v0.8.15 

type ReadmeObject struct {
	Template            string
	Title               string
	Description         string
	ApplicationCommands CommandInfos
	OtherBuildCommands  CommandInfos
	Configs             ConfigInfos
}

ReadmeObject represent readme documentation

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.