document

func (Blocks) CodeBlocks ¶

func (b Blocks) CodeBlocks() (result CodeBlocks)

func (*CodeBlock) Attributes ¶

func (b *CodeBlock) Attributes() map[string]string

Attributes returns code block attributes detected in the first line. They are of a form: "sh { attr=value }".

func (*CodeBlock) Content ¶

func (b *CodeBlock) Content() string

Content returns unaltered snippet as a single blob of text.

func (*CodeBlock) Executable ¶

func (b *CodeBlock) Executable() string

Executable returns an identifier of a program to execute the block.

func (*CodeBlock) Intro ¶

func (b *CodeBlock) Intro() string

Intro returns a normalized description of the code block based on the preceding paragraph.

func (*CodeBlock) Line ¶

func (b *CodeBlock) Line(idx int) string

Line returns a normalized code block line at index.

func (*CodeBlock) LineCount ¶

func (b *CodeBlock) LineCount() int

LineCount returns the number of code block lines.

func (*CodeBlock) Lines ¶

func (b *CodeBlock) Lines() (result []string)

Lines returns all code block lines, normalized.

func (*CodeBlock) MarshalJSON ¶

func (b *CodeBlock) MarshalJSON() ([]byte, error)

func (*CodeBlock) Name ¶

func (b *CodeBlock) Name() string

Name returns a code block name.

func (*CodeBlock) SetContent ¶

func (b *CodeBlock) SetContent(str string)

SetContent sets a new content of the block.

func (CodeBlocks) Lookup ¶

func (b CodeBlocks) Lookup(name string) *CodeBlock

func (CodeBlocks) Names ¶

func (b CodeBlocks) Names() (result []string)

func (*MarkdownBlock) Content ¶

func (b *MarkdownBlock) Content() string

func (*MarkdownBlock) MarshalJSON ¶

func (b *MarkdownBlock) MarshalJSON() ([]byte, error)

func (*ParsedSource) Blocks ¶

func (s *ParsedSource) Blocks() Blocks

func (*ParsedSource) CodeBlocks ¶

func (s *ParsedSource) CodeBlocks() CodeBlocks

func (*ParsedSource) Root ¶

func (s *ParsedSource) Root() ast.Node

func (*ParsedSource) Source ¶

func (s *ParsedSource) Source() []byte

func (*ParsedSource) SquashedBlocks ¶

func (s *ParsedSource) SquashedBlocks() (blocks Blocks, err error)

func (*Source) Parse ¶

func (s *Source) Parse() *ParsedSource