Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pkg

package

Go to main page

Versions in this module

v0

v0.0.6

Sep 15, 2018

v0.0.5

Sep 11, 2018

v0.0.4

Sep 3, 2018

Changes in this version

type Config

+ AllowCodeBlocks bool

+ AllowRedirect bool

+ ReguestRepeats int8

type FileConfig

+ AllowCodeBlocks *bool

+ AllowRedirect *bool

+ ReguestRepeats *int8

type Link

+ Config *LinkConfig

type LinkConfig

+ AllowRedirect *bool

+ ReguestRepeats *int8

+ func NewLinkConfig(link Link, file *File) *LinkConfig

type Links

+ func NewLinks(filePath string, config *Config) Links

+ func (l Links) AppendConfig(file *File) Links

v0.0.3

Aug 31, 2018

Changes in this version

+ func SetTimeout(timeout int)

type Config

+ IgnoreExternal bool

+ IgnoreInternal bool

+ ReguestTimes int8

+ Timeout int

type FileConfig

+ IgnoreExternal bool

+ IgnoreInternal bool

+ ReguestTimes int8

+ Timeout int

type Link

+ ReguestTimes int8

+ Timeout int8

+ type LinkConfig struct

+ ReguestTimes int8

+ Timeout int

type Links

+ func (l Links) Filter(condition func(link Link) bool) Links

type Parser

+ func (p *Parser) Anchors(body io.ReadCloser) (ids []string)

v0.0.2

Jul 22, 2018

Changes in this version

+ func SetBasePath(path string, absolute bool)

+ type Config struct

+ BlackList []string

+ Files []File

+ WhiteListExt []string

+ WhiteListInt []string

+ func NewConfig(commands cli.Commands) (*Config, error)

+ type FailedLinks struct

+ Count int

+ Links []Link

+ type File struct

+ AbsPath string

+ Config *FileConfig

+ Content string

+ DirPath string

+ Headers Headers

+ Links Links

+ RelPath string

+ Stats *FileStats

+ Status bool

+ func NewFile(filePath string, config *FileConfig) (*File, error)

+ func (f *File) ExtractHeaders()

+ func (f *File) ExtractLinks()

+ func (f *File) ExtractStats()

+ func (f *File) Run()

+ func (f *File) Summary()

+ func (f *File) ValidateLinks()

+ func (f *File) WriteStats()

+ type FileConfig struct

+ WhiteListExt []string

+ WhiteListInt []string

+ func NewFileConfig(filePath string, config *Config) *FileConfig

+ type FileStats struct

+ FailedLinks FailedLinks

+ SuccessLinks SuccessLinks

+ func NewFileStats(file *File) *FileStats

+ type Files []*File

+ func NewFiles(filePaths []string, config *Config) (Files, error)

+ func (f Files) Run()

+ func (f Files) Summary() bool

+ type FilesStats []*FileStats

+ func NewFilesStats(files Files) FilesStats

+ type Headers []string

+ type Link struct

+ AbsPath string

+ RelPath string

+ Result LinkResult

+ TypeOf LinkType

+ type LinkResult struct

+ Message string

+ Status bool

+ type LinkType string

+ const ExternalLink

+ const HashInternalLink

+ const InternalLink

+ type Links []Link

+ func (l Links) CheckStatus() bool

+ func (l Links) RemoveWhiteLinks(externals, internals []string) Links

+ type Parser struct

+ func (p *Parser) Headers(markdown string) []string

+ func (p *Parser) Links(content, dirPath string) Links

+ type SuccessLinks struct

+ Count int

+ Links []Link

+ type Validation struct

+ func (v *Validation) ExternalLinks(links Links) (Links, error)

+ func (v *Validation) HashInternalLinks(links Links, headers Headers) (Links, error)

+ func (v *Validation) InternalLink(links Links) (Links, error)

+ func (v *Validation) Links(links []Link, optionalHeaders ...Headers) []Link