docatl

Documentation

Index

• func Build(docsPath string, meta BuildMetadata) (string, error)
• func WriteConfig(configPath string, config Config) error
• type BuildMetadata
  • func ExtractMetadata(docsPath string) (BuildMetadata, error)
• type Config
• type Docat
  • func (docat *Docat) Claim(project string) (ProjectClaim, error)
  • func (docat *Docat) Delete(project string, version string) error
  • func (docat *Docat) HideOrShowVersion(project string, version string, hide bool) error
  • func (docat *Docat) Post(project string, version string, docsPath string) error
  • func (docat *Docat) PushIcon(project string, iconPath string) error
  • func (docat *Docat) Rename(project string, newName string) error
  • func (docat *Docat) Tag(project string, version string, tag string) error
• type ProjectClaim

Functions

func Build

func Build(docsPath string, meta BuildMetadata) (string, error)

func WriteConfig

func WriteConfig(configPath string, config Config) error

Types

type BuildMetadata

type BuildMetadata struct {
	Host    string `yaml:"host,omitempty"`
	Project string `yaml:"project,omitempty"`
	Version string `yaml:"version,omitempty"`
}

func ExtractMetadata

func ExtractMetadata(docsPath string) (BuildMetadata, error)

type Config

type Config struct {
	Host   string `yaml:"host"`
	ApiKey string `yaml:"api-key"`
}

type Docat

type Docat struct {
	Host   string
	ApiKey string
}

func (*Docat) Claim

func (docat *Docat) Claim(project string) (ProjectClaim, error)

func (*Docat) Delete

func (docat *Docat) Delete(project string, version string) error

func (*Docat) HideOrShowVersion

func (docat *Docat) HideOrShowVersion(project string, version string, hide bool) error

func (*Docat) Post

func (docat *Docat) Post(project string, version string, docsPath string) error

func (*Docat) PushIcon

func (docat *Docat) PushIcon(project string, iconPath string) error

func (*Docat) Rename

func (docat *Docat) Rename(project string, newName string) error

func (*Docat) Tag

func (docat *Docat) Tag(project string, version string, tag string) error

type ProjectClaim

type ProjectClaim struct {
	Token string
}