site

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Jul 9, 2026 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Package site assembles the output directory: the byte-for-byte mirror layer, the /view/ browse layer (ADR-001), and the agent surface (llms.txt, optional llms-full.txt, index.json, robots.txt). All emitted links are relative and no page may reference an external origin.

Index

Constants

This section is empty.

Variables

View Source
var GeneratorVersion = "dev"

GeneratorVersion is the default version string used outside the CLI.

Functions

This section is empty.

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(cfg *config.Config, renderer *theme.Renderer) *Builder

func (*Builder) Build

func (b *Builder) Build(ctx context.Context, tree *source.Tree, outDir string) (Stats, error)

func (*Builder) SetGeneratorVersion

func (b *Builder) SetGeneratorVersion(version string)

type Stats

type Stats struct {
	// Pages counts generated browser-layer HTML pages. A renderable index.html
	// merged into its directory page is counted only as that directory page.
	Files, Pages int
	Duration     time.Duration
	// Warnings collects build-time warnings produced by site assembly.
	// Config cascade warnings are reported by the cli layer before these.
	Warnings []config.Warning
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL