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

html

package

Go to main page

Versions in this module

v0

v0.8.1

Feb 13, 2024

v0.8.0

Feb 12, 2024

Changes in this version

type PackageIndex

+ func (idx *PackageIndex) IsInternal() bool

type PackageInfo

+ PkgVersion string

+ func (b *PackageInfo) IsInternal() bool

type Renderer

+ Pagefind bool

+ func (r *Renderer) RenderSiteIndex(w io.Writer, sidx *SiteIndex) error

+ type SiteIndex struct

+ Path string

+ Sites []string

v0.7.0

Jan 20, 2024

Changes in this version

+ const StaticDir

type PackageIndex

+ SubDirDepth int

type PackageInfo

+ SubDirDepth int

v0.6.0

Nov 15, 2023

v0.5.2

Nov 11, 2023

v0.5.1

Nov 11, 2023

v0.5.0

Aug 3, 2023

Changes in this version

type Renderer

+ NormalizeRelativePath func(string) string

v0.4.1

Jan 27, 2023

v0.4.0

Jan 20, 2023

v0.3.0

Jan 19, 2023

Changes in this version

+ type Highlighter interface

+ Highlight func(*highlight.Code) string

+ WriteCSS func(io.Writer) error

type Renderer

+ Highlighter Highlighter

v0.2.0

Jan 15, 2023

Changes in this version

type Renderer

+ Home string

v0.1.1

Jan 10, 2023

v0.1.0

Jan 8, 2023

Changes in this version

+ type Breadcrumb struct

+ Path string

+ Text string

+ type CommentDocPrinter struct

+ func (dp *CommentDocPrinter) WithHeadingLevel(lvl int) DocPrinter

+ type DocPrinter interface

+ HTML func(*comment.Doc) []byte

+ WithHeadingLevel func(int) DocPrinter

+ type PackageIndex struct

+ Breadcrumbs []Breadcrumb

+ NumChildren int

+ Path string

+ Subpackages []Subpackage

+ func (idx *PackageIndex) Basename() string

+ type PackageInfo struct

+ Breadcrumbs []Breadcrumb

+ DocPrinter DocPrinter

+ NumChildren int

+ Subpackages []Subpackage

+ func (b *PackageInfo) Basename() string

+ type Renderer struct

+ Embedded bool

+ FrontMatter *ttemplate.Template

+ Internal bool

+ func (r *Renderer) RenderPackage(w io.Writer, info *PackageInfo) error

+ func (r *Renderer) RenderPackageIndex(w io.Writer, pidx *PackageIndex) error

+ func (r *Renderer) WriteStatic(dir string) error

+ type Subpackage struct

+ RelativePath string

+ Synopsis string