gentoc

package
v0.59.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 18, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Marshal 

func Marshal(nav *Nav) ([]byte, error)

Marshal serialises nav to YAML bytes.

Types

type Builder added in v0.59.0 

type Builder struct {
	Registry       registry.Interface
	IndexFileNames []string
	// contains filtered or unexported fields
}

Builder holds configuration needed to build the navigation structure.

func NewBuilder added in v0.59.0 

func NewBuilder(reg registry.Interface, indexFileNames []string) *Builder

NewBuilder creates a Builder. indexFileNames lists filenames treated as section index files (e.g. ["readme.md", "README.md"]); _index.md is always treated as one.

func (*Builder) FromNodes added in v0.59.0 

func (b *Builder) FromNodes(ctx context.Context, nodes []*manifest.Node, stripRoot bool) *Nav

FromNodes builds a Nav from the resolved manifest node tree. nodes[0] is expected to be the root node produced by manifest.ResolveManifest. stripRoot removes the top-level directory prefix from all filenames. 

type Nav struct {
	Nav []*NavEntry `yaml:"nav"`
}

Nav is the top-level navigation document. 

type NavEntry struct {
	// Title is the human-readable display name for this entry.
	// Resolved via: manifest frontmatter.title > document frontmatter.title > filename derivation.
	Title    string      `yaml:"title"`
	Filename string      `yaml:"filename"`
	Subnav   []*NavEntry `yaml:"subnav,omitempty"`
}

NavEntry represents one entry in the generated navigation structure.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.