staticdoc

Documentation

Index

• Variables
• type Files
  • func Generate(ctx context.Context, r io.Reader, root string, opt Options) (*Files, error)
• type Options

Variables

var TestingOptions = Options{
	MatchingTags:     nil,
	JSON:             true,
	Markdown:         true,
	MarkdownMetadata: true,
}

Types

type Files

type Files struct {
	ByPath map[string][]byte
}

func Generate

func Generate(ctx context.Context, r io.Reader, root string, opt Options) (*Files, error)

type Options

type Options struct {
	// MatchingTags is a list of tags (exported, unexported, deprecated, etc.) and if the
	// documentation page or section does not match at least one of them, it will be omitted.
	MatchingTags []protocol.Tag

	// Emit raw JSON representation of pages.
	JSON bool

	// Emit Markdown representation of pages.
	Markdown bool

	// Emit metadata in markdown (search keys, tags, etc.)
	MarkdownMetadata bool
}