Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

generate

package

Go to main page

Versions in this module

v0

v0.5.0

Jul 26, 2026

Changes in this version

+ type DirectiveExample struct

+ Bad string

+ Good string

+ type GenerationDirective struct

+ Checklist []string

+ Examples []DirectiveExample

+ Priority int

+ Prompt string

+ Required bool

+ RuleID string

+ Template string

+ Title string

+ type GenerationMetadata struct

+ Author string

+ TotalRules int

+ type GenerationPhase struct

+ Description string

+ Directives []GenerationDirective

+ ID string

+ Name string

+ Order int

+ type GenerationRubric struct

+ Description string

+ Metadata *GenerationMetadata

+ Name string

+ Phases []GenerationPhase

+ Version string

+ func GenerationRubricFromSpec(spec *types.APIStyleSpec) *GenerationRubric

+ func (r *GenerationRubric) ToJSON() ([]byte, error)

v0.4.0

Jul 6, 2026

v0.3.0

Jun 22, 2026

Changes in this version

+ func WriteMkDocs(result *MkDocsResult, outputDir string) error

type MarkdownOptions

+ IncludeDescription bool

+ IncludeGlossary bool

+ IncludeIntroduction bool

+ IncludePatterns bool

+ IncludePrinciples bool

+ type MkDocsOptions struct

+ IncludeSearch bool

+ MarkdownOptions *MarkdownOptions

+ RepoURL string

+ SiteName string

+ SiteURL string

+ SplitCategories bool

+ SplitPatterns bool

+ Theme string

+ func DefaultMkDocsOptions() *MkDocsOptions

+ type MkDocsResult struct

+ Config string

+ Pages map[string]string

+ func MkDocs(spec *types.APIStyleSpec, opts *MkDocsOptions) (*MkDocsResult, error)

v0.2.0

Jun 7, 2026

v0.1.0

Jun 7, 2026

Changes in this version

+ func Markdown(spec *types.APIStyleSpec, opts *MarkdownOptions) (string, error)

+ func Spectral(spec *types.APIStyleSpec, opts *SpectralOptions) (string, error)

+ type MarkdownOptions struct

+ IncludeConformance bool

+ IncludeExamples bool

+ IncludeMetadata bool

+ IncludeRationale bool

+ IncludeReferences bool

+ IncludeTOC bool

+ SeverityEmojis bool

+ func DefaultMarkdownOptions() *MarkdownOptions

+ type SpectralOptions struct

+ IncludeDescriptions bool

+ IncludeDisabled bool

+ SkipNonEnforceable bool

+ func DefaultSpectralOptions() *SpectralOptions