local

Documentation

Index

• type Config
• type Provider
  • func New(config Config) (*Provider, error)
  • func (p *Provider) GetFile(ctx context.Context, service, path string) ([]byte, error)
  • func (p *Provider) GetIndex(ctx context.Context, service string) (*shared.Index, error)
  • func (p *Provider) GetIndexes(ctx context.Context) ([]shared.Index, error)
  • func (p *Provider) GetMarkdown(ctx context.Context, service, path string) (string, error)

Types

type Config

type Config struct {
	RootDirectory string `json:"rootDirectory"`
}

Config is the structure of the configuration for the local file system provider.

type Provider

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

Provider implements the Provider interface.

func New

func New(config Config) (*Provider, error)

New returns a new local provider. The local provider can be used to access TechDocs from the local file system.

func (*Provider) GetFile

func (p *Provider) GetFile(ctx context.Context, service, path string) ([]byte, error)

GetFile returns a single file.

func (*Provider) GetIndex

func (p *Provider) GetIndex(ctx context.Context, service string) (*shared.Index, error)

GetIndex returns a single index for a service.

func (*Provider) GetIndexes

func (p *Provider) GetIndexes(ctx context.Context) ([]shared.Index, error)

GetIndexes returns a list indexes for all services.

func (*Provider) GetMarkdown

func (p *Provider) GetMarkdown(ctx context.Context, service, path string) (string, error)

GetMarkdown returns a single markdown file.