Help us shape the future of Go! Take the 2026 Go Developer Survey

generator

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package generator builds the public website documentation from handwritten Markdown.

Index

Constants

This section is empty.

Variables

View Source
var ErrMarkdown = errors.New("invalid guide Markdown")

ErrMarkdown identifies unsupported or incomplete guide markup.

Functions

func Generate

func Generate(output string) error

Generate writes the guide landing page, game paths, shared topics, complete guide, downloadable Markdown and embedded images beneath output. It leaves other files alone and refuses linked or non-regular destinations.

func GenerateDesign

func GenerateDesign(output string) error

GenerateDesign writes the design section into its explicitly selected directory. It uses the same confined output handling and offline theme as the guides.

func GenerateTechnical

func GenerateTechnical(output string) error

GenerateTechnical writes API topics and downloads into a confined directory.

Types

This section is empty.

Jump to

Keyboard shortcuts

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