site

package
v1.2.3 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DefaultOutputDir = "glaze-site"
	DefaultSiteTitle = "Glazed Help Browser"
	DefaultDataDir   = "site-data"
)

Variables

This section is empty.

Functions

func RenderSite

func RenderSite(ctx context.Context, hs *help.HelpSystem, settings *RenderSiteSettings) error

Types

type Manifest

type Manifest struct {
	GeneratedBy   string   `json:"generatedBy"`
	SiteTitle     string   `json:"siteTitle"`
	TotalSections int      `json:"totalSections"`
	DataBasePath  string   `json:"dataBasePath"`
	TopLevelSlugs []string `json:"topLevelSlugs"`
	DefaultSlugs  []string `json:"defaultSlugs"`
}

type RenderSiteCommand

type RenderSiteCommand struct {
	*cmds.CommandDescription
	// contains filtered or unexported fields
}

func NewRenderSiteCommand

func NewRenderSiteCommand(hs *help.HelpSystem) (*RenderSiteCommand, error)

func (*RenderSiteCommand) Run

func (c *RenderSiteCommand) Run(ctx context.Context, parsedValues *values.Values) error

type RenderSiteSettings

type RenderSiteSettings struct {
	OutputDir string   `glazed:"output-dir"`
	SiteTitle string   `glazed:"site-title"`
	BasePath  string   `glazed:"base-path"`
	DataDir   string   `glazed:"data-dir"`
	Overwrite bool     `glazed:"overwrite"`
	Paths     []string `glazed:"paths"`
}

type RuntimeConfig

type RuntimeConfig struct {
	Mode        string `json:"mode"`
	APIBaseURL  string `json:"apiBaseUrl,omitempty"`
	DataBaseURL string `json:"dataBasePath,omitempty"`
	SiteTitle   string `json:"siteTitle"`
}

type SlugIndex

type SlugIndex struct {
	Items map[string][]string `json:"items"`
}

Jump to

Keyboard shortcuts

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