site

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2025 License: AGPL-3.0 Imports: 14 Imported by: 0

Documentation

Overview

Package site provides Hugo-based static site generation for Starmap documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	RootDir    string // Root directory for the site (default: ./site)
	ContentDir string // Content directory (default: ./docs)
	BaseURL    string // Base URL for the site
	Theme      string // Hugo theme to use (default: hugo-book)
}

Config holds website configuration.

type Site 

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

Site represents a Hugo-based documentation website.

func New 

func New(config *Config) (*Site, error)

New creates a new Site instance.

func (*Site) Generate 

func (s *Site) Generate(ctx context.Context, catalog catalogs.Reader) error

Generate builds the static site from the current catalog.

func (*Site) Serve 

func (s *Site) Serve(ctx context.Context, port int) error

Serve starts the Hugo development server.

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.