docatl

package

v1.0.0 Latest Latest Go to latest Published: Apr 14, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/docat-org/docatl

Links

Open Source Insights

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
type ProjectClaim

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Build ¶ added in v0.6.0

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

func WriteConfig ¶ added in v0.6.0

func WriteConfig(configPath string, config Config) error

Types ¶

type BuildMetadata ¶ added in v0.6.0

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

func ExtractMetadata ¶ added in v0.6.0

func ExtractMetadata(docsPath string) (BuildMetadata, error)

type Config ¶ added in v0.6.0

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 ¶ added in v1.0.0

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 ¶ added in v0.9.0

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

func (*Docat) Rename ¶ added in v1.0.0

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
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL