go.bigb.es/curator

v1.1.0
Doc Versions Source

Functions

f func StaticFS

src 
func StaticFS() http.FileSystem

StaticFS returns the embedded static assets filesystem.

f func TrustedHTML

src 
func TrustedHTML(s string) template.HTML

TrustedHTML converts a string to template.HTML for pre-sanitized content.

Types

T type FuncData

src 
type FuncData struct {
	Name string
	Doc  template.HTML
	Decl string
	Recv string
}

FuncData wraps godoc.FuncDoc for templates.

T type IndexEntry

src 
type IndexEntry struct {
	Anchor string
	Text   string
}

IndexEntry represents an entry in the package index.

T type ModulePageData

src 
type ModulePageData struct {
	Host         string
	ImportPrefix string
	ModuleName   string
	VCS          string
	Repo         string
	Version      string
	SubPath      string
	Versions     []string

	// Package doc fields.
	Doc         template.HTML
	Synopsis    string
	PackageName string
	Index       []IndexEntry
	Consts      []ValueData
	Vars        []ValueData
	Funcs       []FuncData
	Types       []TypeData
	SubPackages []godoc.SubPkgSummary
	SourceFiles []string
}

ModulePageData is the template data for module/package pages.

f func BuildModulePageData

src 
func BuildModulePageData(host, modName, version, subpath, vcs, repo string, doc *godoc.PackageDoc, versions []string, subPkgs []godoc.SubPkgSummary) *ModulePageData

BuildModulePageData creates template data from a PackageDoc.

T type Renderer

src 
type Renderer struct {
	// contains filtered or unexported fields
}

Renderer handles HTML rendering of documentation pages.

f func NewRenderer

src 
func NewRenderer() (*Renderer, error)

NewRenderer creates a renderer with parsed templates.

m func (*Renderer) RenderModule

src 
func (r *Renderer) RenderModule(w io.Writer, data *ModulePageData) error

RenderModule renders a module/package documentation page.

m func (*Renderer) RenderSource

src 
func (r *Renderer) RenderSource(w io.Writer, data *SourcePageData) error

RenderSource renders a source code view page.

m func (*Renderer) RenderVersions

src 
func (r *Renderer) RenderVersions(w io.Writer, data *VersionsPageData) error

RenderVersions renders a version list page.

T type SourcePageData

src 
type SourcePageData struct {
	Host              string
	ImportPrefix      string
	ModuleName        string
	VCS               string
	Repo              string
	Version           string
	SubPath           string
	FileName          string
	HighlightedSource template.HTML
	SourceFiles       []string
}

SourcePageData is the template data for source file view.

T type TypeData

src 
type TypeData struct {
	Name    string
	Doc     template.HTML
	Decl    string
	Consts  []ValueData
	Vars    []ValueData
	Funcs   []FuncData
	Methods []FuncData
}

TypeData wraps godoc.TypeDoc for templates.

T type ValueData

src 
type ValueData struct {
	Names []string
	Doc   template.HTML
	Decl  string
}

ValueData wraps godoc.ValueDoc for templates.

T type VersionsPageData

src 
type VersionsPageData struct {
	Host           string
	ImportPrefix   string
	ModuleName     string
	VCS            string
	Repo           string
	Versions       []string
	CurrentVersion string
}

VersionsPageData is the template data for the versions list.

Source Files