Documentation
¶
Index ¶
- type Config
- type Instance
- func (i *Instance) GetFile(ctx context.Context, service, path string) ([]byte, error)
- func (i *Instance) GetIndex(ctx context.Context, service string) (*shared.Index, error)
- func (i *Instance) GetIndexes(ctx context.Context) ([]shared.Index, error)
- func (i *Instance) GetMarkdown(ctx context.Context, service, path string) (*shared.Markdown, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Name string `json:"name"`
DisplayName string `json:"displayName"`
Description string `json:"description"`
Home bool `json:"home"`
Provider providers.Config `json:"provider"`
}
Config is the structure of the configuration for a single TechDocs instance.
type Instance ¶
type Instance struct {
Name string
// contains filtered or unexported fields
}
Instance represents a single TechDocs instance, which can be added via the configuration file.
func (*Instance) GetIndexes ¶
GetIndexes returns a list of indexes.
Source Files
Click to show internal directories.
Click to hide internal directories.