gitbook

Documentation

Index

• type ComponentGitbook
• type Config
  • func (config Config) BuildGitbook() []error
• type ControlGitbook
• type OpenControlGitBook

Types

type ComponentGitbook

type ComponentGitbook struct {
	base.Component
	// contains filtered or unexported fields
}

ComponentGitbook struct is an extension of models.Component that adds an exportPath

type Config

type Config struct {
	OpencontrolDir string
	Certification  string
	ExportPath     string
	MarkdownPath   string
}

Config contains data for gitbook export configurations

func (Config) BuildGitbook

func (config Config) BuildGitbook() []error

BuildGitbook entry point for creating gitbook

type ControlGitbook

type ControlGitbook struct {
	*models.Control
	// contains filtered or unexported fields
}

ControlGitbook struct is an extension of models.Control that adds an exportPath

type OpenControlGitBook

type OpenControlGitBook struct {
	*models.OpenControl

	FSUtil fs.Util
	// contains filtered or unexported fields
}

OpenControlGitBook struct is an extension of models.OpenControl that adds an exportPath