parser

Documentation

Index

• type MarkdownSection
• type ParsedDocs
• type Parser
  • func New(logger *logrus.Logger) *Parser
  • func (p *Parser) GenerateJSON(packageDir string, cfg *config.DocgenConfig) error
• type Section
• type Subsection

Types

type MarkdownSection

type MarkdownSection struct {
	Title      string
	Content    string
	CodeBlocks []string
}

MarkdownSection represents a parsed markdown section

type ParsedDocs

type ParsedDocs struct {
	Sections map[string]interface{} `json:"sections"`
}

ParsedDocs represents the complete parsed documentation

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser converts markdown documentation to structured JSON

func New

func New(logger *logrus.Logger) *Parser

New creates a new parser instance

func (*Parser) GenerateJSON

func (p *Parser) GenerateJSON(packageDir string, cfg *config.DocgenConfig) error

GenerateJSON reads markdown files and generates structured JSON

type Section

type Section struct {
	Title       string       `json:"title"`
	Content     string       `json:"content"`
	Subsections []Subsection `json:"subsections,omitempty"`
	CodeBlocks  []string     `json:"code_blocks,omitempty"`
}

Section represents a parsed documentation section

type Subsection

type Subsection struct {
	Title      string   `json:"title"`
	Content    string   `json:"content"`
	CodeBlocks []string `json:"code_blocks,omitempty"`
}

Subsection represents a subsection within a documentation section