mkdocs

Documentation

Index

• func CopyConfig(configFile string, tmpFile string) error
• func GenerateMdFile(filePath string, funcMap template.FuncMap, example any) error
• type Config
  • func ReadConfig(configFile string) (*Config, error)
• type Generator
  • func (g Generator) AddModule(ctx context.Context, tcModule context.TestcontainersModule) error

Functions

func CopyConfig

func CopyConfig(configFile string, tmpFile string) error

func GenerateMdFile

func GenerateMdFile(filePath string, funcMap template.FuncMap, example any) error

Types

type Config

type Config struct {
	SiteName string   `yaml:"site_name"`
	SiteURL  string   `yaml:"site_url"`
	Plugins  []string `yaml:"plugins"`
	Theme    struct {
		Name      string `yaml:"name"`
		CustomDir string `yaml:"custom_dir"`
		Palette   struct {
			Scheme string `yaml:"scheme"`
		} `yaml:"palette"`
		Font struct {
			Text string `yaml:"text"`
			Code string `yaml:"code"`
		} `yaml:"font"`
		Logo    string `yaml:"logo"`
		Favicon string `yaml:"favicon"`
	} `yaml:"theme"`
	ExtraCSS           []string      `yaml:"extra_css"`
	RepoName           string        `yaml:"repo_name"`
	RepoURL            string        `yaml:"repo_url"`
	MarkdownExtensions []interface{} `yaml:"markdown_extensions"`
	Nav                []struct {
		Home               string        `yaml:"Home,omitempty"`
		Quickstart         string        `yaml:"Quickstart,omitempty"`
		Features           []interface{} `yaml:"Features,omitempty"`
		Examples           []string      `yaml:"Examples,omitempty"`
		Modules            []string      `yaml:"Modules,omitempty"`
		SystemRequirements []interface{} `yaml:"System Requirements,omitempty"`
		Contributing       string        `yaml:"Contributing,omitempty"`
		GettingHelp        string        `yaml:"Getting help,omitempty"`
	} `yaml:"nav"`
	EditURI string `yaml:"edit_uri"`
	Extra   struct {
		LatestVersion string `yaml:"latest_version"`
	} `yaml:"extra"`
}

func ReadConfig

func ReadConfig(configFile string) (*Config, error)

type Generator

type Generator struct{}

func (Generator) AddModule

func (g Generator) AddModule(ctx context.Context, tcModule context.TestcontainersModule) error

AddModule update modules in mkdocs