Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Aggregator ¶
type Aggregator struct {
// contains filtered or unexported fields
}
func New ¶
func New(logger *logrus.Logger) *Aggregator
func (*Aggregator) Aggregate ¶
func (a *Aggregator) Aggregate(outputDir string, mode string, transform string) error
Aggregate collects documentation from ecosystems specified in the local docgen.config.yml. If no ecosystems are specified, it falls back to the current ecosystem only and warns the user. The transform parameter specifies output transformations (e.g., "astro" for website builds).
type ConceptManifest ¶
type ConceptManifest struct {
ID string `yaml:"id"`
Title string `yaml:"title"`
Description string `yaml:"description"`
Status string `yaml:"status"`
DocgenPublish string `yaml:"docgen_publish"` // draft | dev | production
DocgenOrder []string `yaml:"docgen_order"` // ordered list of .md files
}
ConceptManifest represents the concept-manifest.yml structure
Source Files
Click to show internal directories.
Click to hide internal directories.