Documentation
¶
Overview ¶
Package example provides extraction of code examples from documentation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CodeBlock ¶
type CodeBlock struct {
// contains filtered or unexported fields
}
CodeBlock represents a code block extracted from documentation.
func NewCodeBlock ¶
NewCodeBlock creates a new CodeBlock.
func (CodeBlock) HasContext ¶
HasContext returns true if context is available.
func (CodeBlock) HasLanguage ¶
HasLanguage returns true if a language is specified.
type Discovery ¶
type Discovery struct {
// contains filtered or unexported fields
}
Discovery detects example files in repositories.
func (*Discovery) IsDocumentationFile ¶
IsDocumentationFile checks if file is a documentation file.
func (*Discovery) IsExampleCandidate ¶
IsExampleCandidate checks if file should be processed for examples.
func (*Discovery) IsExampleDirectoryFile ¶
IsExampleDirectoryFile checks if file is in an example directory.
type MarkdownParser ¶
type MarkdownParser struct {
// contains filtered or unexported fields
}
MarkdownParser parses Markdown documentation.
func NewMarkdownParser ¶
func NewMarkdownParser() *MarkdownParser
NewMarkdownParser creates a new MarkdownParser.
func (*MarkdownParser) Parse ¶
func (p *MarkdownParser) Parse(content string) []CodeBlock
Parse extracts code blocks from Markdown content.
type Parser ¶
Parser extracts code blocks from documentation content.
func ParserForExtension ¶
ParserForExtension returns the appropriate parser for a file extension.
func ParserForFile ¶
ParserForFile returns the appropriate parser for a file path.
Source Files