💾 Archived View for code.pfad.fr › vanitydoc › template captured on 2024-05-12 at 15:08:47. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2024-03-21)
-=-=-=-=-=-=-
import "code.pfad.fr/vanitydoc/template"
package template generates documentation for a given package.
func Synopsis(ctx build.Context, modulePath string, packageChain []string) string
Synopsis returns a cleaned version of the first sentence of the documentation
func WriteCSS(w io.Writer) error
WriteCSS writes the default CSS to the given writer.
type Directory struct {
Name string
Synopsis string
}
Directory represents the sub-packages of a given package.
type GemtextRenderer struct {
BaseURL string
DocSite string // defaults to "gemini://godocs.io"
}
GemtextRenderer provides the generation of [gemtext] documentation.
func (gr GemtextRenderer) Execute(out io.Writer, td TemplateData) error
Execute applies a parsed template to the template data, and writes the output to w.
type HTMLRenderer struct {
Stylesheets []string
// AdditionalFS and AdditionalPattern can be optionally provided
// to override some components
AdditionalFS fs.FS
AdditionalPatterns []string
BaseURL string
DocSite string // defaults to "https://pkg.go.dev"
}
HTMLRenderer provides the generation of HTML documentation.
func (hr HTMLRenderer) Execute(out io.Writer, td TemplateData) error
Execute applies a parsed template to the template data, and writes the output to w.
func (hr HTMLRenderer) NotFound(out io.Writer, baseURL, modulePath, importPath, ref string) error
Execute applies a parsed template to the template data, and writes the output to w.
type TemplateData struct {
Package *doc.Package
FileSet *token.FileSet
ModulePath string
PackageChain []string
Directories []Directory
VCS autodiscovery.VCS
Ref string
}
TemplateData stores all the data needed to render the documentation templates.
func NewTemplateData( ctx build.Context, modulePath string, packageChain []string, directories []Directory, vcs autodiscovery.VCS, ref string, ) (TemplateData, error)
NewTemplateData parses the provided pkgFS to prepare the template data.
func (td TemplateData) AdjustedImportPath() string
AdjustedImportPath removes "std/" prefix (for showing the stdlib).
func (td TemplateData) PageName() string
PageName returns the page name ("*** package" or "*** command" depending on the package name).