docs

Documentation

Overview

Package docs provides automated API documentation generation for Gomontage.

The generator produces markdown files covering all public APIs of the framework. Guide pages (getting started, clips, timeline, effects, export) are maintained as hand-written markdown templates. API reference pages are auto-generated from Go source code using AST parsing, extracting every exported type, function, method, and constant along with their doc comments and full signatures.

Usage:

gomontage docs              # Generates docs/ directory
gomontage docs -o api-docs  # Custom output directory

Index

• func Generate(outputDir string) error

Functions

func Generate

func Generate(outputDir string) error

Generate produces markdown documentation files in the specified output directory. It copies hand-written guide templates and auto-generates API reference pages from the Go source code.