archdocs

Documentation

Overview

Package archdocs generates static architecture documentation for a repository by uploading it to the Supermodel API, converting the returned graph to markdown via graph2md, and building a static HTML site with pssg.

Index

• func Run(ctx context.Context, cfg *config.Config, dir string, opts Options) error
• type Options

Functions

func Run

func Run(ctx context.Context, cfg *config.Config, dir string, opts Options) error

Run generates architecture documentation for the repository at dir.

Types

type Options

type Options struct {
	// SiteName is the display title for the generated site.
	// Defaults to "<repo> Architecture Docs".
	SiteName string

	// BaseURL is the canonical base URL where the site will be hosted.
	// Defaults to "https://example.com".
	BaseURL string

	// Repo is the "owner/repo" GitHub slug used to build a repo URL and
	// derive defaults. Optional – inferred from git remote when empty.
	Repo string

	// Output is the directory to write the generated site into.
	// Defaults to "./arch-docs-output".
	Output string

	// TemplatesDir overrides the bundled HTML/CSS/JS templates.
	TemplatesDir string

	// MaxSourceFiles caps how many source files are included in the archive
	// sent to the API. 0 means unlimited.
	MaxSourceFiles int

	// MaxEntities caps how many entity pages are generated. 0 means unlimited.
	MaxEntities int

	// Force bypasses the analysis cache and re-uploads even if cached.
	Force bool
}

Options configures the arch-docs command.