docsite

Documentation

Overview

Package docsite generates a static documentation website from PSL protocols.

Index

• func Generate(cfg *Config) error
• func GenerateJSON(lib *protocol.Library, outDir string) error
• type Config

Functions

func Generate

func Generate(cfg *Config) error

Generate creates a static documentation site.

func GenerateJSON

func GenerateJSON(lib *protocol.Library, outDir string) error

GenerateJSON exports all protocol metadata as JSON for doc site consumption.

Types

type Config

type Config struct {
	Title   string
	Lang    string // "en" or "zh"
	OutDir  string
	BaseURL string
	Lib     *protocol.Library
}

Config holds documentation site generation configuration.