githubdoc

Documentation

Index

• type Document
• type FetchOptions
• type Fetcher
  • func NewFetcher(client httpClient) Fetcher
  • func (fetcher Fetcher) Fetch(ctx context.Context, options FetchOptions) ([]Document, error)
  • func (fetcher Fetcher) WithAPIBase(base string) Fetcher
  • func (fetcher Fetcher) WithAuthorizationToken(token string) Fetcher
  • func (fetcher Fetcher) WithTimeout(duration time.Duration) Fetcher
  • func (fetcher Fetcher) WithUserAgent(agent string) Fetcher
• type RuleSet
  • func LoadRuleSet(path string) (RuleSet, error)

Types

type Document

type Document struct {
	Path    string
	Content string
}

type FetchOptions

type FetchOptions struct {
	Owner      string
	Repository string
	Reference  string
	RootPath   string
	RuleSet    RuleSet
}

type Fetcher

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

func NewFetcher

func NewFetcher(client httpClient) Fetcher

func (Fetcher) Fetch

func (fetcher Fetcher) Fetch(ctx context.Context, options FetchOptions) ([]Document, error)

func (Fetcher) WithAPIBase

func (fetcher Fetcher) WithAPIBase(base string) Fetcher

func (Fetcher) WithAuthorizationToken

func (fetcher Fetcher) WithAuthorizationToken(token string) Fetcher

WithAuthorizationToken configures the fetcher to authenticate GitHub API calls.

func (Fetcher) WithTimeout

func (fetcher Fetcher) WithTimeout(duration time.Duration) Fetcher

func (Fetcher) WithUserAgent

func (fetcher Fetcher) WithUserAgent(agent string) Fetcher

type RuleSet

type RuleSet struct {
	IncludeExtensions []string
	SkipDirectory     string
	DropExpressions   []string
	StripLeadingH1    bool
	BumpHeadingsBy    int
}

func LoadRuleSet

func LoadRuleSet(path string) (RuleSet, error)