webdoc

package
v0.99.0 Latest Latest
Warning

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

Go to latest
Published: Aug 14, 2026 License: GPL-3.0 Imports: 15 Imported by: 0

Documentation

Overview

Package webdoc generates the Flowbot documentation website from markdown sources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WebDocAction

func WebDocAction(_ *cobra.Command, _ []string) error

WebDocAction generates the documentation website from markdown sources.

Types

type DocNavPage

type DocNavPage struct {
	Title  string
	URL    string // relative to docs/website/, e.g. "docs/getting-started/"
	Active bool
	IsSub  bool
}

DocNavPage represents a single page in the docs sidebar navigation.

type DocSection

type DocSection struct {
	Title string
	Pages []DocNavPage
}

DocSection represents a top-level documentation section with its pages.

type FrontMatter

type FrontMatter struct {
	Title       string `yaml:"title"`
	Description string `yaml:"description"`
	AccentColor string `yaml:"accent_color"`
	Wide        bool   `yaml:"wide"`
	HideSidebar bool   `yaml:"hide_sidebar"`
}

FrontMatter holds the parsed YAML front matter from a markdown file. Fields are optional; zero values mean "not set" and will not override defaults.

type Page

type Page struct {
	Title        string
	Description  string
	CanonicalURL string
	Content      template.HTML
	BasePath     string
	DocSections  []DocSection
	AccentColor  string
	Wide         bool
	HideSidebar  bool
}

Page holds data for the HTML template.

Jump to

Keyboard shortcuts

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