Documentation ¶
Overview ¶
Package flags parses args and returns them as a struct.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Args ¶
type Args struct { BaseURL string GitHubPages bool GitHubPagesToken string GitHubPagesUser string IncludeInHead FilePathContents IndexInternalPackages bool SourceLinkTemplate string OutputPath string SiteDescription string SiteTitle string Watch bool // not added as a flag, only enabled when running from ./cmd/watch }
Args contains all command-line options for gopages
type FilePathContents ¶
type FilePathContents struct {
// contains filtered or unexported fields
}
FilePathContents is a flag that reads a file by the passed in path and contains its contents
func (*FilePathContents) Contents ¶
func (f *FilePathContents) Contents() []byte
Contents returns the contents of this flag's file
func (*FilePathContents) Set ¶
func (f *FilePathContents) Set(s string) error
Set implements flag.Value
func (*FilePathContents) String ¶
func (f *FilePathContents) String() string
type GoPagesLinker ¶
type GoPagesLinker struct {
// contains filtered or unexported fields
}
GoPagesLinker is the default GoPages source.Linker, which links to scraped godoc source pages
func (*GoPagesLinker) LinkToSource ¶
func (l *GoPagesLinker) LinkToSource(packagePath string, options source.LinkOptions) url.URL
LinkToSource implements source.Linker
type TemplateLinker ¶
type TemplateLinker struct {
// contains filtered or unexported fields
}
TemplateLinker is a custom template-based source.Linker, which links to external source pages
func (*TemplateLinker) LinkToSource ¶
func (l *TemplateLinker) LinkToSource(packagePath string, options source.LinkOptions) url.URL
LinkToSource implements source.Linker
func (*TemplateLinker) ShouldScrapePackage ¶
func (l *TemplateLinker) ShouldScrapePackage(packagePath string) bool
ShouldScrapePackage implements source.ScrapeChecker
Click to show internal directories.
Click to hide internal directories.