pkg

Documentation

Overview

package pkg computes and generate documentation for a given package.

Index

• func CopyAsset(dst io.Writer, name string) error
• func Gemtext(out io.Writer, pkg Package) error
• type HTMLRenderer
  • func (hr HTMLRenderer) Render(out io.Writer, pkg Package) error
• type Package
  • func (p *Package) ParseFS(subFS fs.FS) error
• Bugs

Functions

func CopyAsset

func CopyAsset(dst io.Writer, name string) error

CopyAsset copy the given assets from the template folder.

func Gemtext

func Gemtext(out io.Writer, pkg Package) error

Gemtext generates gemtext for the given Package.

Types

type HTMLRenderer

type HTMLRenderer struct {
	// AdditionalFS and AdditionalPattern can be optionally provided
	// to override some components
	AdditionalFS       fs.FS
	AdditionalPatterns []string
}

func (HTMLRenderer) Render

func (hr HTMLRenderer) Render(out io.Writer, pkg Package) error

Render HTML for the given Package.

type Package

type Package struct {
	ModulePath   string
	PackageChain []string
	VCS          autodiscovery.VCS
	Ref          string // ref for the autodiscovery links
	Stylesheets  []string
	SubPackages  []string
	SubSynopsis  map[string]string

	// populated by calling ParseFS
	Doc *doc.Package
	// contains filtered or unexported fields
}

Package holds the documentation data of a given package.

func (*Package) ParseFS

func (p *Package) ParseFS(subFS fs.FS) error

NewPackage computes Doc and FileSet fields for a package.

Notes

Bugs

• no idea how build tags should be managed