docs

Documentation

Index

• func Path(section string) string
• type RepoPathURL
  • func ParseRepoPathURL(url string) (RepoPathURL, bool)

Functions

func Path

func Path(section string) string

Path returns the url to the given section of documentation.

Types

type RepoPathURL

type RepoPathURL struct {
	// RepoPath is the relative path to an asset in the repository.
	RepoPath string
}

RepoPathURL is a URL that points to a path in the repository, helpful for identifying links that link to assets in the repository from our documentation.

func ParseRepoPathURL

func ParseRepoPathURL(url string) (RepoPathURL, bool)

ParseRepoPathURL will return true and the details of the repository path URL if the URL is a URL that points to an asset in the repository, or false otherwise.