postaco

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Dec 3, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DoctypePostman = "postman"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
}

type ConfigBuildDir

type ConfigBuildDir struct {
	SourcePath string `validate:"required,ne="`
	OutputPath string `validate:"required,ne="`

	Logger            io.Writer             `validate:"required"`
	PostmanDocBuilder docbuilder.DocBuilder `validate:"required"`

	DocTitle string `validate:"required,ne="`
}

type DocumentIndex

type DocumentIndex struct {
	Kind       string   `json:"kind"`
	Title      string   `json:"title"`
	Indexables []string `json:"indexables"`

	DocumentRelDir          string `json:"document_dir"`
	DocumentRelPathMarkdown string `json:"document_path_markdown"`
	DocumentRelPathSource   string `json:"document_path_source"`

	Rel string `json:"rel"`
}

type Documentation

type Documentation struct {
	Name     string
	Document []DocumentIndex `json:"documents"`
}

type Postaco

type Postaco interface {
	BuildDir(ctx context.Context, cfg ConfigBuildDir) (err error)
}

func New

func New(cfg Config) Postaco

type PostacoStruct

type PostacoStruct struct {
	// contains filtered or unexported fields
}

func (*PostacoStruct) BuildDir

func (e *PostacoStruct) BuildDir(ctx context.Context, config ConfigBuildDir) (err error)

Jump to

Keyboard shortcuts

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