mkdocs

Documentation

Overview

Package mkdocs generates MkDocs-compatible markdown files for visionspec projects.

Index

• func GenerateProjectIndex(w io.Writer, report *status.Report, opts ProjectIndexOptions) error
• func GenerateSpecsLanding(w io.Writer, projects []ProjectSummary, opts SpecsLandingOptions) error
• func WriteProjectIndex(projectPath string, report *status.Report, opts ProjectIndexOptions) error
• func WriteSpecsLanding(specsDir string, opts SpecsLandingOptions) error
• type ProjectIndexOptions
• type ProjectSummary
  • func ScanProjects(specsDir string) ([]ProjectSummary, error)
• type SpecsLandingOptions

Functions

func GenerateProjectIndex

func GenerateProjectIndex(w io.Writer, report *status.Report, opts ProjectIndexOptions) error

GenerateProjectIndex generates index.md for a single project.

func GenerateSpecsLanding

func GenerateSpecsLanding(w io.Writer, projects []ProjectSummary, opts SpecsLandingOptions) error

GenerateSpecsLanding generates the main docs/specs/index.md file.

func WriteProjectIndex

func WriteProjectIndex(projectPath string, report *status.Report, opts ProjectIndexOptions) error

WriteProjectIndex writes index.md for a project.

func WriteSpecsLanding

func WriteSpecsLanding(specsDir string, opts SpecsLandingOptions) error

WriteSpecsLanding writes the main specs/index.md file.

Types

type ProjectIndexOptions

type ProjectIndexOptions struct {
	// IncludeGraphLink adds a link to the graph visualization if available.
	IncludeGraphLink bool
	// GraphPath is the relative path to the graph HTML file.
	GraphPath string
}

ProjectIndexOptions configures project index generation.

type ProjectSummary

type ProjectSummary struct {
	Name          string
	Path          string
	Status        string // ready, in_progress, not_ready
	StatusEmoji   string
	Progress      int // Percentage
	LastUpdated   time.Time
	SpecCount     int
	EvalCount     int
	ApprovalCount int
}

ProjectSummary contains summary information for the specs landing page.

func ScanProjects

func ScanProjects(specsDir string) ([]ProjectSummary, error)

ScanProjects scans a specs directory and returns summaries for all projects.

type SpecsLandingOptions

type SpecsLandingOptions struct {
	// IncludeConstitution adds a link to CONSTITUTION.md if it exists.
	IncludeConstitution bool
	// IncludeRoadmap adds a link to ROADMAP.md if it exists.
	IncludeRoadmap bool
	// ConstitutionPath is the relative path to CONSTITUTION.md.
	ConstitutionPath string
	// RoadmapPath is the relative path to ROADMAP.md.
	RoadmapPath string
}

SpecsLandingOptions configures the specs landing page generation.