types

package

Go to main page

Versions in this module

v0

v0.8.0

Oct 22, 2022

Changes in this version

+ const AttrChromaClassPrefix

+ const AttrEmail

+ const LiteralParagraph

+ const Open

+ func NewAttributeReference(name, rawText string) (interface{}, error)

+ func TrimTrailingSpaces(content []interface{}) []interface

type Attributes

+ func (a Attributes) Unset(key string)

type Document

+ func (d *Document) FrontMatter() *FrontMatter

+ func (d *Document) SectionNumbers() (SectionNumbers, error)

type HAlign

+ const HAlignDefault

type ImageBlock

+ func (i *ImageBlock) Reference(refs ElementReferences)

type InlineLink

+ func NewEmailAddressLink(address string) (*InlineLink, error)

type InternalCrossReference

+ func (x *InternalCrossReference) ResolveID(attrs Attributes) error

+ type ListContinuation struct

+ Element interface{}

+ Offset int

+ func NewListContinuation(offset int, Element interface{}) (*ListContinuation, error)

+ func (c *ListContinuation) AddElement(element interface{}) error

type Location

+ func (l *Location) ToDisplayString() string

+ func (l *Location) ToString() string

type RawLine

+ func (r *RawLine) Append(s string)

+ func (r *RawLine) Contains(substr string) bool

+ func (r *RawLine) HasSuffix(suffix string) bool

+ type SectionNumbers map[string]string

+ type SinglelineComment struct

+ Content string

+ func NewSinglelineComment(content string) (*SinglelineComment, error)

type Table

+ func (t *Table) SetColumnDefinitions(cols []interface{})

type TableCell

+ Format string

+ func NewInlineTableCell(content *RawLine) (*TableCell, error)

+ func NewMultilineTableCell(elements []interface{}, format interface{}) (*TableCell, error)

type UnorderedListElementBulletStyle

+ func NewUnorderedListElementBulletStyle(style string) (UnorderedListElementBulletStyle, error)

type VAlign

+ const VAlignDefault

v0.7.0

Mar 20, 2022

Changes in this version

+ const AttrAutoWidth

+ const AttrButtonLabel

+ const AttrDescription

+ const AttrExperimental

+ const AttrImagesDir

+ const AttrNumbered

+ const AttrSectionNumbering

+ const AttrTableOfContentsTitle

+ const AttrXRefLabel

+ const MarkdownCode

+ var EqualOperand = func(left, right interface{}) bool

+ var GreaterOrEqualOperand = func(left, right interface{}) bool

+ var GreaterThanOperand = func(left, right interface{}) bool

+ var LessOrEqualOperand = func(left, right interface{}) bool

+ var LessThanOperand = func(left, right interface{}) bool

+ var NotEqualOperand = func(left, right interface{}) bool

+ func AllNilEntries(elements []interface{}) bool

+ func Append(elements ...interface{}) ([]interface{}, error)

+ func Flatten(elements []interface{}) []interface

+ func InsertAt(elements []interface{}, element interface{}, index int) []interface

+ func SplitElementsPerLine(elements []interface{}) [][]interface

+ func TrimLeft(elements []interface{}, cutset string) []interface

type AttributeDeclaration

+ func (a *AttributeDeclaration) RawText() (string, error)

+ type AttributeReference struct

+ Name string

+ func (s *AttributeReference) RawText() (string, error)

type AttributeReset

+ func (a *AttributeReset) RawText() (string, error)

type Attributes

+ func MergeAttributes(attributes ...interface{}) (Attributes, error)

+ func (a Attributes) AddAll(others Attributes) Attributes

+ func (a Attributes) Clone() Attributes

+ func (a Attributes) GetAsBoolWithDefault(key string, defaultValue bool) bool

+ func (a Attributes) GetAsIntWithDefault(key string, defaultValue int) int

+ type BlockDelimiter struct

+ Attributes Attributes

+ Kind string

+ Length int

+ func NewBlockDelimiter(kind string, length int, rawText string) (*BlockDelimiter, error)

+ func NewMarkdownCodeBlockDelimiter(language, rawText string) (*BlockDelimiter, error)

+ func (b *BlockDelimiter) RawText() (string, error)

+ type BlockDelimiterKind string

+ type CalloutListElement struct

+ Attributes Attributes

+ Elements []interface{}

+ Ref int

+ func NewCalloutListElement(ref int, content RawLine) (*CalloutListElement, error)

+ func (e *CalloutListElement) AddAttributes(attributes Attributes)

+ func (e *CalloutListElement) AddElement(element interface{}) error

+ func (e *CalloutListElement) AdjustStyle(l *List)

+ func (e *CalloutListElement) GetAttributes() Attributes

+ func (e *CalloutListElement) GetElements() []interface{}

+ func (e *CalloutListElement) LastElement() interface{}

+ func (e *CalloutListElement) ListKind() ListKind

+ func (e *CalloutListElement) Reference(refs ElementReferences)

+ func (e *CalloutListElement) SetAttributes(attributes Attributes)

+ func (e *CalloutListElement) SetElements(elements []interface{}) error

+ func (e *CalloutListElement) SubstituteFootnotes(notes *Footnotes)

+ type ConditionalInclusion interface

+ Eval func(attributes map[string]interface{}) bool

+ SingleLineContent func() (string, bool)

+ type ContentStyle string

+ const AsciidocStyle

+ const DefaultStyle

+ const EmphasisStyle

+ const HeaderStyle

+ const LiteralStyle

+ const MonospaceStyle

+ const StrongStyle

type CounterSubstitution

+ func (s *CounterSubstitution) RawText() (string, error)

type DelimitedBlock

+ func (b *DelimitedBlock) GetAttributes() Attributes

+ func (b *DelimitedBlock) GetElements() []interface{}

+ func (b *DelimitedBlock) Reference(refs ElementReferences)

+ func (b *DelimitedBlock) SetAttributes(attributes Attributes)

+ func (b *DelimitedBlock) SetElements(elements []interface{}) error

type Document

+ TableOfContents *TableOfContents

+ func (d *Document) AddElement(element interface{}) error

+ func (d *Document) BodyElements() []interface{}

+ type DocumentAuthorFullName struct

+ FirstName string

+ LastName string

+ MiddleName string

+ func NewDocumentAuthorFullName(part1 string, part2, part3 interface{}) (*DocumentAuthorFullName, error)

+ func (n *DocumentAuthorFullName) FullName() string

+ func (n *DocumentAuthorFullName) Initials() string

+ type DocumentAuthors []*DocumentAuthor

+ func (authors DocumentAuthors) Expand() Attributes

+ type DocumentAuthorsAndRevision struct

+ Authors DocumentAuthors

+ Revision *DocumentRevision

+ func NewDocumentAuthorsAndRevision(authors DocumentAuthors, revision interface{}) (*DocumentAuthorsAndRevision, error)

+ type DocumentFragment struct

+ Elements []interface{}

+ Error error

+ Position Position

+ func NewDocumentFragment(p Position, elements ...interface{}) DocumentFragment

+ func NewErrorFragment(p Position, err error) DocumentFragment

type DocumentHeader

+ Attributes Attributes

+ Elements []interface{}

+ Title []interface{}

+ func (h *DocumentHeader) AddAttributes(attributes Attributes)

+ func (h *DocumentHeader) Authors() DocumentAuthors

+ func (h *DocumentHeader) GetAttributes() Attributes

+ func (h *DocumentHeader) GetElements() []interface{}

+ func (h *DocumentHeader) GetTitle() []interface{}

+ func (h *DocumentHeader) IsEmpty() bool

+ func (h *DocumentHeader) Revision() *DocumentRevision

+ func (h *DocumentHeader) SetAttributes(attributes Attributes)

+ func (h *DocumentHeader) SetElements(elements []interface{}) error

+ func (h *DocumentHeader) SetTitle(title []interface{}) error

+ type DocumentInformation struct

+ Title []interface{}

+ func NewDocumentInformation(title []interface{}, ar interface{}) (*DocumentInformation, error)

type DocumentRevision

+ func (r *DocumentRevision) Expand() Attributes

+ type EndOfCondition struct

+ func NewEndOfCondition() (*EndOfCondition, error)

type ExternalCrossReference

+ Attributes Attributes

+ func (x *ExternalCrossReference) AddAttributes(attributes Attributes)

+ func (x *ExternalCrossReference) GetAttributes() Attributes

+ func (x *ExternalCrossReference) GetLocation() *Location

+ func (x *ExternalCrossReference) SetAttributes(attributes Attributes)

type FileInclusion

+ func (f *FileInclusion) AddAttributes(attributes Attributes)

+ func (f *FileInclusion) GetAttributes() Attributes

+ func (f *FileInclusion) GetLocation() *Location

+ func (f *FileInclusion) SetAttributes(attributes Attributes)

+ type Filterable interface

+ IsEmpty func() bool

type FrontMatter

+ Attributes map[string]interface{}

+ type HAlign string

+ const HAlignCenter

+ const HAlignLeft

+ const HAlignRight

+ type IfdefCondition struct

+ Name string

+ Substitution string

+ func NewIfdefCondition(name string, attr interface{}) (*IfdefCondition, error)

+ func (c *IfdefCondition) Eval(attributes map[string]interface{}) bool

+ func (c *IfdefCondition) SingleLineContent() (string, bool)

+ type IfevalCondition struct

+ Left interface{}

+ Operand IfevalOperand

+ Right interface{}

+ func NewIfevalCondition(left, right interface{}, operand IfevalOperand) (*IfevalCondition, error)

+ func (c *IfevalCondition) Eval(attributes map[string]interface{}) bool

+ func (c *IfevalCondition) SingleLineContent() (string, bool)

+ type IfevalOperand func(left, right interface{}) bool

+ func NewEqualOperand() (IfevalOperand, error)

+ func NewGreaterOrEqualOperand() (IfevalOperand, error)

+ func NewGreaterThanOperand() (IfevalOperand, error)

+ func NewLessOrEqualOperand() (IfevalOperand, error)

+ func NewLessThanOperand() (IfevalOperand, error)

+ func NewNotEqualOperand() (IfevalOperand, error)

+ type IfndefCondition struct

+ Name string

+ Substitution string

+ func NewIfndefCondition(name string, attr interface{}) (*IfndefCondition, error)

+ func (c *IfndefCondition) Eval(attributes map[string]interface{}) bool

+ func (c *IfndefCondition) SingleLineContent() (string, bool)

type ImageBlock

+ func (i *ImageBlock) GetAttributes() Attributes

+ func (i *ImageBlock) GetLocation() *Location

+ func (i *ImageBlock) SetAttributes(attributes Attributes)

+ type InlineButton struct

+ Attributes Attributes

+ func NewInlineButton(attrs Attributes) (*InlineButton, error)

type InlineImage

+ func (i *InlineImage) GetAttributes() Attributes

+ func (i *InlineImage) GetLocation() *Location

+ func (i *InlineImage) SetAttributes(attributes Attributes)

type InlineLink

+ func NewInlineAnchor(id string) (*InlineLink, error)

+ func (l *InlineLink) AddAttributes(attributes Attributes)

+ func (l *InlineLink) GetAttributes() Attributes

+ func (l *InlineLink) GetLocation() *Location

+ func (l *InlineLink) SetAttributes(attributes Attributes)

+ type InlineMenu struct

+ Path []string

+ func NewInlineMenu(id string, attrs Attributes) (*InlineMenu, error)

+ type LabeledListElement struct

+ Attributes Attributes

+ Elements []interface{}

+ Style LabeledListElementStyle

+ Term []interface{}

+ func NewLabeledListElement(level int, term, description interface{}) (*LabeledListElement, error)

+ func (e *LabeledListElement) AddAttributes(attributes Attributes)

+ func (e *LabeledListElement) AddElement(element interface{}) error

+ func (e *LabeledListElement) AdjustStyle(l *List)

+ func (e *LabeledListElement) GetAttributes() Attributes

+ func (e *LabeledListElement) GetElements() []interface{}

+ func (e *LabeledListElement) LastElement() interface{}

+ func (e *LabeledListElement) ListKind() ListKind

+ func (e *LabeledListElement) Reference(refs ElementReferences)

+ func (e *LabeledListElement) SetAttributes(attributes Attributes)

+ func (e *LabeledListElement) SetElements(elements []interface{}) error

+ func (e *LabeledListElement) SubstituteFootnotes(notes *Footnotes)

+ type LabeledListElementStyle string

+ const DoubleColons

+ const QuadrupleColons

+ const TripleColons

type List

+ Attributes Attributes

+ Elements []ListElement

+ Kind ListKind

+ func (l *List) AddAttributes(attrs Attributes)

+ func (l *List) AddElement(element interface{}) error

+ func (l *List) CanAddElement(element interface{}) bool

+ func (l *List) GetAttributes() Attributes

+ func (l *List) GetElements() []interface{}

+ func (l *List) LastElement() ListElement

+ func (l *List) Reference(refs ElementReferences)

+ func (l *List) SetAttributes(attrs Attributes)

+ func (l *List) SetElements(elements []interface{}) error

+ type ListElement interface

+ AdjustStyle func(*List)

+ LastElement func() interface{}

+ ListKind func() ListKind

+ type ListElementContinuation struct

+ Element interface{}

+ Offset int

+ func NewListElementContinuation(offset int, Element interface{}) (*ListElementContinuation, error)

+ func (c *ListElementContinuation) AddElement(element interface{}) error

+ type ListElements struct

+ Elements []interface{}

+ func NewListElements(elements []interface{}) (*ListElements, error)

+ func (l *ListElements) AddAttributes(attrs Attributes)

+ func (l *ListElements) GetAttributes() Attributes

+ func (l *ListElements) GetElements() []interface{}

+ func (l *ListElements) SetAttributes(Attributes)

+ func (l *ListElements) SetElements(elements []interface{}) error

+ func (l *ListElements) SubstituteFootnotes(notes *Footnotes)

+ type ListKind string

+ const CalloutListKind

+ const LabeledListKind

+ const OrderedListKind

+ const UnorderedListKind

type Location

+ func (l *Location) SetPath(path interface{})

+ func (l *Location) SetPathPrefix(p interface{})

+ func (l *Location) TrimAngleBracketSuffix() (bool, error)

+ type Options []interface

+ type OrderedListElement struct

+ Attributes Attributes

+ Elements []interface{}

+ Style string

+ func NewOrderedListElement(prefix OrderedListElementPrefix, content interface{}) (*OrderedListElement, error)

+ func (e *OrderedListElement) AddAttributes(attributes Attributes)

+ func (e *OrderedListElement) AddElement(element interface{}) error

+ func (e *OrderedListElement) AdjustStyle(l *List)

+ func (e *OrderedListElement) GetAttributes() Attributes

+ func (e *OrderedListElement) GetElements() []interface{}

+ func (e *OrderedListElement) LastElement() interface{}

+ func (e *OrderedListElement) ListKind() ListKind

+ func (e *OrderedListElement) Reference(refs ElementReferences)

+ func (e *OrderedListElement) SetAttributes(attributes Attributes)

+ func (e *OrderedListElement) SetElements(elements []interface{}) error

+ func (e *OrderedListElement) SubstituteFootnotes(notes *Footnotes)

+ type OrderedListElementPrefix struct

+ Style string

+ func NewOrderedListElementPrefix(s string) (OrderedListElementPrefix, error)

type Paragraph

+ Elements []interface{}

+ func NewLiteralParagraph(kind string, elements []interface{}) (*Paragraph, error)

+ func (p *Paragraph) AddElement(e interface{}) error

+ func (p *Paragraph) GetAttributes() Attributes

+ func (p *Paragraph) GetElements() []interface{}

+ func (p *Paragraph) Reference(refs ElementReferences)

+ func (p *Paragraph) SetAttributes(attributes Attributes)

+ func (p *Paragraph) SetElements(elements []interface{}) error

+ type Position struct

+ End int

+ Start int

type Preamble

+ TableOfContents *TableOfContents

type QuotedText

+ func (t *QuotedText) AddAttributes(attributes Attributes)

+ func (t *QuotedText) GetAttributes() Attributes

+ func (t *QuotedText) GetElements() []interface{}

+ func (t *QuotedText) SetAttributes(attributes Attributes)

+ func (t *QuotedText) SetElements(elements []interface{}) error

+ type RawContent string

+ func NewRawContent(content string) (RawContent, error)

type RawSection

+ func (s *RawSection) OffsetLevel(offset int)

+ type Referencable interface

+ Reference func(refs ElementReferences)

+ type Roles []interface

type Section

+ func (s *Section) GetAttributes() Attributes

+ func (s *Section) GetElements() []interface{}

+ func (s *Section) GetID() (string, error)

+ func (s *Section) GetTitle() []interface{}

+ func (s *Section) Reference(refs ElementReferences)

+ func (s *Section) SetAttributes(attributes Attributes)

+ func (s *Section) SetElements(elements []interface{}) error

+ func (s *Section) SetTitle(title []interface{}) error

+ type Symbol struct

+ Name string

+ Prefix string

+ func NewSymbol(name string) (*Symbol, error)

+ func NewSymbolWithForeword(name, foreword string) (*Symbol, error)

+ func (s *Symbol) RawText() (string, error)

type Table

+ Footer *TableRow

+ Rows []*TableRow

+ func (t *Table) GetAttributes() Attributes

+ func (t *Table) GetElements() []interface{}

+ func (t *Table) Reference(refs ElementReferences)

+ func (t *Table) SetAttributes(attributes Attributes)

+ func (t *Table) SetElements(elements []interface{}) error

+ type TableCell struct

+ Elements []interface{}

+ func NewTableCell(content RawContent) (*TableCell, error)

+ func (c *TableCell) AddAttributes(_ Attributes)

+ func (c *TableCell) GetAttributes() Attributes

+ func (c *TableCell) GetElements() []interface{}

+ func (c *TableCell) SetAttributes(_ Attributes)

+ func (c *TableCell) SetElements(elements []interface{}) error

type TableColumn

+ Autowidth bool

+ Multiplier int

+ Weight int

+ func NewTableColumn(multiplier, halign, valign, weight, style interface{}) (*TableColumn, error)

type TableOfContents

+ MaxDepth int

+ func NewTableOfContents(maxDepth int) *TableOfContents

+ func (t *TableOfContents) Add(s *Section)

+ type TableRow struct

+ Cells []*TableCell

+ func NewTableRow(elements []interface{}) (*TableRow, error)

+ func (r *TableRow) AddAttributes(_ Attributes)

+ func (r *TableRow) GetAttributes() Attributes

+ func (r *TableRow) GetElements() []interface{}

+ func (r *TableRow) SetAttributes(_ Attributes)

+ func (r *TableRow) SetElements(elements []interface{}) error

type ToCSection

+ Number string

+ type UnorderedListElement struct

+ Attributes Attributes

+ BulletStyle UnorderedListElementBulletStyle

+ CheckStyle UnorderedListElementCheckStyle

+ Elements []interface{}

+ func NewUnorderedListElement(prefix UnorderedListElementPrefix, checkstyle interface{}, content interface{}) (*UnorderedListElement, error)

+ func (e *UnorderedListElement) AddAttributes(attributes Attributes)

+ func (e *UnorderedListElement) AddElement(element interface{}) error

+ func (e *UnorderedListElement) AdjustStyle(l *List)

+ func (e *UnorderedListElement) GetAttributes() Attributes

+ func (e *UnorderedListElement) GetElements() []interface{}

+ func (e *UnorderedListElement) LastElement() interface{}

+ func (e *UnorderedListElement) ListKind() ListKind

+ func (e *UnorderedListElement) Reference(refs ElementReferences)

+ func (e *UnorderedListElement) SetAttributes(attributes Attributes)

+ func (e *UnorderedListElement) SetElements(elements []interface{}) error

+ func (e *UnorderedListElement) SubstituteFootnotes(notes *Footnotes)

+ type UnorderedListElementBulletStyle string

+ type UnorderedListElementCheckStyle string

+ type UnorderedListElementPrefix struct

+ BulletStyle UnorderedListElementBulletStyle

+ func NewUnorderedListElementPrefix(s UnorderedListElementBulletStyle) (UnorderedListElementPrefix, error)

+ type VAlign string

+ const VAlignBottom

+ const VAlignMiddle

+ const VAlignTop

type WithAttributes

+ AddAttributes func(Attributes)

+ GetAttributes func() Attributes

+ SetAttributes func(Attributes)

+ type WithElementAddition interface

+ AddElement func(interface{}) error

+ type WithElements interface

+ GetElements func() []interface{}

+ SetElements func([]interface{}) error

+ type WithFootnotes interface

+ SubstituteFootnotes func(existing *Footnotes)

+ type WithLocation interface

+ GetLocation func() *Location

+ type WithTitle interface

+ GetTitle func() []interface{}

+ SetTitle func([]interface{}) error

v0.6.0

Mar 21, 2021

Changes in this version

+ const AttrHeight

+ const AttrIDSeparator

+ const AttrInlineLinkTarget

+ const AttrInteractive

+ const AttrOption

+ const AttrPositional1

+ const AttrPositionalIndex

+ const AttrPositionalPrefix

+ const AttrRoles

+ const AttrSourceBlockOption

+ const DefaultIDSeparator

+ const DoubleQuoteBold

+ const DoubleQuoteItalic

+ const DoubleQuoteMarked

+ const DoubleQuoteMonospace

+ const SingleQuoteBold

+ const SingleQuoteItalic

+ const SingleQuoteMarked

+ const SingleQuoteMonospace

+ const SingleQuoteSubscript

+ const SingleQuoteSuperscript

+ func HasAttributeWithValue(attributes interface{}, key string, value interface{}) bool

+ func HasNotAttribute(attributes interface{}, key string) bool

+ type Attribute struct

+ Key string

+ Value interface{}

+ func NewIDAttribute(id interface{}) (Attribute, error)

+ func NewInlineIDAttribute(id string) (Attribute, error)

+ func NewNamedAttribute(key string, value interface{}) (Attribute, error)

+ func NewOptionAttribute(options interface{}) (Attribute, error)

+ func NewRoleAttribute(role interface{}) (Attribute, error)

+ func NewTitleAttribute(title interface{}) (Attribute, error)

type AttributeDeclaration

+ func (a AttributeDeclaration) ElementsToSubstitute() []interface{}

+ func (a AttributeDeclaration) ReplaceElements(value []interface{}) interface{}

+ func (a AttributeDeclaration) Stringify() string

type AttributeSubstitution

+ func (s AttributeSubstitution) RawText() (string, error)

type Attributes

+ func (a Attributes) SetAll(attr interface{}) Attributes

+ type CommentBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewCommentBlock(lines []interface{}, attributes interface{}) (CommentBlock, error)

type DraftDocument

+ Elements []interface{}

+ type ExampleBlock struct

+ Attributes Attributes

+ Elements []interface{}

+ func NewExampleBlock(elements []interface{}, attributes interface{}) (ExampleBlock, error)

+ func (b ExampleBlock) AttributesToSubstitute() Attributes

+ func (b ExampleBlock) DefaultSubstitutions() []string

+ func (b ExampleBlock) ElementsToSubstitute() []interface{}

+ func (b ExampleBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b ExampleBlock) ReplaceElements(elements []interface{}) interface{}

+ func (b ExampleBlock) SubstitutionsToApply() ([]string, error)

type ExternalCrossReference

+ func (r ExternalCrossReference) ElementsToSubstitute() []interface{}

+ func (r ExternalCrossReference) ReplaceElements(path []interface{}) interface{}

+ func (r ExternalCrossReference) RestoreElements(placeholders map[string]interface{}) interface{}

+ type FencedBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewFencedBlock(lines []interface{}, attributes interface{}) (FencedBlock, error)

+ func (b FencedBlock) AttributesToSubstitute() Attributes

+ func (b FencedBlock) DefaultSubstitutions() []string

+ func (b FencedBlock) LinesToSubstitute() [][]interface{}

+ func (b FencedBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b FencedBlock) SubstituteLines(lines [][]interface{}) interface{}

+ func (b FencedBlock) SubstitutionsToApply() ([]string, error)

type Footnote

+ func (n Footnote) RestoreElements(placeholders map[string]interface{}) interface{}

type FootnotesContainer

+ SubstituteFootnotes func(existing *Footnotes) interface{}

type ImageBlock

+ func (i ImageBlock) AttributesToSubstitute() Attributes

+ func (i ImageBlock) ElementsToSubstitute() []interface{}

+ func (i ImageBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (i ImageBlock) ReplaceElements(path []interface{}) interface{}

+ func (i ImageBlock) RestoreAttributes(placeholders map[string]interface{}) interface{}

+ func (i ImageBlock) RestoreLocation(placeholders map[string]interface{}) interface{}

type IndexTerm

+ func (t IndexTerm) RestoreElements(placeholders map[string]interface{}) interface{}

type InlineImage

+ func (i InlineImage) AttributesToSubstitute() Attributes

+ func (i InlineImage) ElementsToSubstitute() []interface{}

+ func (i InlineImage) ReplaceAttributes(attributes Attributes) interface{}

+ func (i InlineImage) ReplaceElements(path []interface{}) interface{}

+ func (i InlineImage) RestoreAttributes(placeholders map[string]interface{}) interface{}

+ func (i InlineImage) RestoreLocation(placeholders map[string]interface{}) interface{}

type InlineLink

+ func (l InlineLink) ElementsToSubstitute() []interface{}

+ func (l InlineLink) ReplaceElements(path []interface{}) interface{}

+ func (l InlineLink) RestoreAttributes(placeholders map[string]interface{}) interface{}

+ func (l InlineLink) RestoreLocation(placeholders map[string]interface{}) interface{}

type InlinePassthrough

+ func (p InlinePassthrough) RawText() (string, error)

type LabeledListItem

+ func (i LabeledListItem) AttributesToSubstitute() Attributes

+ func (i LabeledListItem) ElementsToSubstitute() []interface{}

+ func (i LabeledListItem) ReplaceAttributes(attributes Attributes) interface{}

+ func (i LabeledListItem) ReplaceElements(elements []interface{}) interface{}

+ type ListingBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewListingBlock(lines []interface{}, attributes interface{}) (ListingBlock, error)

+ func (b ListingBlock) AttributesToSubstitute() Attributes

+ func (b ListingBlock) DefaultSubstitutions() []string

+ func (b ListingBlock) LinesToSubstitute() [][]interface{}

+ func (b ListingBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b ListingBlock) SubstituteLines(lines [][]interface{}) interface{}

+ func (b ListingBlock) SubstitutionsToApply() ([]string, error)

type LiteralBlock

+ func (b LiteralBlock) AttributesToSubstitute() Attributes

+ func (b LiteralBlock) DefaultSubstitutions() []string

+ func (b LiteralBlock) LinesToSubstitute() [][]interface{}

+ func (b LiteralBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b LiteralBlock) SubstituteLines(lines [][]interface{}) interface{}

+ func (b LiteralBlock) SubstitutionsToApply() ([]string, error)

+ type MarkdownQuoteBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewMarkdownQuoteBlock(lines []interface{}, attributes interface{}) (MarkdownQuoteBlock, error)

type OrderedListItem

+ func (i OrderedListItem) AttributesToSubstitute() Attributes

+ func (i OrderedListItem) ElementsToSubstitute() []interface{}

+ func (i OrderedListItem) ReplaceAttributes(attributes Attributes) interface{}

+ func (i OrderedListItem) ReplaceElements(elements []interface{}) interface{}

type Paragraph

+ func (p Paragraph) AttributesToSubstitute() Attributes

+ func (p Paragraph) DefaultSubstitutions() []string

+ func (p Paragraph) LinesToSubstitute() [][]interface{}

+ func (p Paragraph) ReplaceAttributes(attributes Attributes) interface{}

+ func (p Paragraph) RestoreAttributes(placeholders map[string]interface{}) interface{}

+ func (p Paragraph) RestoreElements(placeholders map[string]interface{}) interface{}

+ func (p Paragraph) SubstituteFootnotes(notes *Footnotes) interface{}

+ func (p Paragraph) SubstituteLines(lines [][]interface{}) interface{}

+ func (p Paragraph) SubstitutionsToApply() ([]string, error)

+ type PassthroughBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewPassthroughBlock(lines []interface{}, attributes interface{}) (PassthroughBlock, error)

+ func (b PassthroughBlock) AttributesToSubstitute() Attributes

+ func (b PassthroughBlock) DefaultSubstitutions() []string

+ func (b PassthroughBlock) LinesToSubstitute() [][]interface{}

+ func (b PassthroughBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b PassthroughBlock) SubstituteLines(lines [][]interface{}) interface{}

+ func (b PassthroughBlock) SubstitutionsToApply() ([]string, error)

+ type PositionalAttribute struct

+ Index int

+ Value interface{}

+ func NewPositionalAttribute(value interface{}) (PositionalAttribute, error)

+ func (a PositionalAttribute) Key() string

+ type QuoteBlock struct

+ Attributes Attributes

+ Elements []interface{}

+ func NewQuoteBlock(elements []interface{}, attributes interface{}) (QuoteBlock, error)

+ func (b QuoteBlock) AttributesToSubstitute() Attributes

+ func (b QuoteBlock) DefaultSubstitutions() []string

+ func (b QuoteBlock) ElementsToSubstitute() []interface{}

+ func (b QuoteBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b QuoteBlock) ReplaceElements(elements []interface{}) interface{}

+ func (b QuoteBlock) SubstitutionsToApply() ([]string, error)

type QuotedString

+ func (s QuotedString) RawText() (string, error)

+ func (s QuotedString) RestoreElements(placeholders map[string]interface{}) interface{}

type QuotedText

+ func (t QuotedText) ElementsToSubstitute() []interface{}

+ func (t QuotedText) RawText() (string, error)

+ func (t QuotedText) ReplaceElements(elements []interface{}) interface{}

+ func (t QuotedText) RestoreAttributes(placeholders map[string]interface{}) interface{}

+ func (t QuotedText) RestoreElements(placeholders map[string]interface{}) interface{}

+ func (t QuotedText) WithAttributes(attributes interface{}) (QuotedText, error)

type RawDocument

+ Elements []interface{}

+ type RawSection struct

+ Level int

+ RawText string

+ Title string

+ func NewRawSection(level int, title string) (RawSection, error)

+ func (s RawSection) Stringify() string

+ type RawText interface

+ RawText func() (string, error)

+ type ReduceOption func(string) string

type Section

+ func (s Section) AttributesToSubstitute() Attributes

+ func (s Section) ElementsToSubstitute() []interface{}

+ func (s Section) ReplaceAttributes(attributes Attributes) interface{}

+ func (s Section) ReplaceElements(title []interface{}) interface{}

+ func (s Section) SubstituteFootnotes(notes *Footnotes) interface{}

+ type SidebarBlock struct

+ Attributes Attributes

+ Elements []interface{}

+ func NewSidebarBlock(elements []interface{}, attributes interface{}) (SidebarBlock, error)

+ func (b SidebarBlock) AttributesToSubstitute() Attributes

+ func (b SidebarBlock) DefaultSubstitutions() []string

+ func (b SidebarBlock) ElementsToSubstitute() []interface{}

+ func (b SidebarBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b SidebarBlock) ReplaceElements(elements []interface{}) interface{}

+ func (b SidebarBlock) SubstitutionsToApply() ([]string, error)

type SpecialCharacter

+ func (c SpecialCharacter) RawText() (string, error)

+ type StandaloneAttributes Attributes

+ func NewStandaloneAttributes(attributes interface{}) (StandaloneAttributes, error)

type StringElement

+ func (s StringElement) RawText() (string, error)

+ type Stringer interface

+ Stringify func() string

type UnorderedListItem

+ func (i UnorderedListItem) AttributesToSubstitute() Attributes

+ func (i UnorderedListItem) ElementsToSubstitute() []interface{}

+ func (i UnorderedListItem) ReplaceAttributes(attributes Attributes) interface{}

+ func (i UnorderedListItem) ReplaceElements(elements []interface{}) interface{}

type UnorderedListItemCheckStyle

+ const CheckedInteractive

+ const UncheckedInteractive

+ type VerseBlock struct

+ Attributes Attributes

+ Lines [][]interface{}

+ func NewVerseBlock(lines []interface{}, attributes interface{}) (VerseBlock, error)

+ func (b VerseBlock) AttributesToSubstitute() Attributes

+ func (b VerseBlock) DefaultSubstitutions() []string

+ func (b VerseBlock) LinesToSubstitute() [][]interface{}

+ func (b VerseBlock) ReplaceAttributes(attributes Attributes) interface{}

+ func (b VerseBlock) SubstituteLines(lines [][]interface{}) interface{}

+ func (b VerseBlock) SubstitutionsToApply() ([]string, error)

+ type WithAttributesToSubstitute interface

+ AttributesToSubstitute func() Attributes

+ ReplaceAttributes func(Attributes) interface{}

+ type WithCustomSubstitutions interface

+ DefaultSubstitutions func() []string

+ SubstitutionsToApply func() ([]string, error)

+ type WithElementsToSubstitute interface

+ ElementsToSubstitute func() []interface{}

+ ReplaceElements func([]interface{}) interface{}

+ type WithLineSubstitution interface

+ LinesToSubstitute func() [][]interface{}

+ SubstituteLines func([][]interface{}) interface{}

+ type WithNestedElementSubstitution interface

+ type WithPlaceholdersInAttributes interface

+ RestoreAttributes func(placeholders map[string]interface{}) interface{}

+ type WithPlaceholdersInElements interface

+ RestoreElements func(placeholders map[string]interface{}) interface{}

+ type WithPlaceholdersInLocation interface

+ RestoreLocation func(placeholders map[string]interface{}) interface{}

v0.5.1

Oct 4, 2020

v0.5.0

Oct 4, 2020

Changes in this version

+ const AttrCaption

+ const AttrCautionCaption

+ const AttrCols

+ const AttrExampleCaption

+ const AttrFigureCaption

+ const AttrFloat

+ const AttrFrame

+ const AttrGrid

+ const AttrIconFlip

+ const AttrIconRotate

+ const AttrIconSize

+ const AttrImageAlign

+ const AttrImageWindow

+ const AttrImportantCaption

+ const AttrNoteCaption

+ const AttrOptions

+ const AttrOpts

+ const AttrPositional2

+ const AttrPositional3

+ const AttrStripes

+ const AttrStyle

+ const AttrSubstitutions

+ const AttrTableCaption

+ const AttrTipCaption

+ const AttrUnicode

+ const AttrVersionLabel

+ const AttrWarningCaption

+ const AttrWidth

+ const MarkdownQuote

+ func NewAttributeSubstitution(name string) (interface{}, error)

+ func NewInlineAttribute(name string, value interface{}) (interface{}, error)

+ func NewString(v interface{}) (string, error)

+ func Reduce(elements interface{}) (interface{}, error)

+ type AttributeDeclaration struct

+ Name string

+ Value string

+ func NewAttributeDeclaration(name string, value interface{}) (AttributeDeclaration, error)

+ type AttributeReset struct

+ Name string

+ func NewAttributeReset(attrName string) (AttributeReset, error)

+ type AttributeSubstitution struct

+ Name string

+ type Attributes map[string]interface

+ func (a Attributes) Add(attrs interface{}) Attributes

+ func (a Attributes) AddNonEmpty(key string, value interface{})

+ func (a Attributes) GetAsBool(key string) bool

+ func (a Attributes) GetAsString(key string) (string, bool)

+ func (a Attributes) GetAsStringWithDefault(key, defaultValue string) string

+ func (a Attributes) Has(key string) bool

+ func (a Attributes) HasOption(key string) bool

+ func (a Attributes) Positionals() [][]interface{}

+ func (a Attributes) Set(key string, value interface{}) Attributes

+ func NewAttributes(attributes interface{}) (Attributes, error)

+ func NewElementNamedAttr(key string, value interface{}) (Attributes, error)

+ func NewElementOption(options interface{}) (Attributes, error)

+ func NewElementStyle(style interface{}) (Attributes, error)

+ func NewPassthroughBlockAttribute() (Attributes, error)

+ type AttributesWithOverrides struct

+ Content map[string]interface{}

+ Counters map[string]interface{}

+ Overrides map[string]string

+ func (a AttributesWithOverrides) Add(attrs map[string]interface{})

+ func (a AttributesWithOverrides) All() Attributes

+ func (a AttributesWithOverrides) GetAsString(key string) (string, bool)

+ func (a AttributesWithOverrides) GetAsStringWithDefault(key, defaultValue string) string

+ func (a AttributesWithOverrides) Set(key string, value interface{})

+ type Callout struct

+ Ref int

+ func NewCallout(ref int) (Callout, error)

+ type CalloutList struct

+ Attributes Attributes

+ Items []CalloutListItem

+ func NewCalloutList(item CalloutListItem) *CalloutList

+ func (l *CalloutList) AddItem(item CalloutListItem)

+ func (l *CalloutList) LastItem() ListItem

+ type CalloutListItem struct

+ Attributes Attributes

+ Elements []interface{}

+ Ref int

+ func NewCalloutListItem(ref int, description []interface{}) (CalloutListItem, error)

+ func (i *CalloutListItem) AddElement(element interface{})

+ func (i CalloutListItem) GetAttributes() Attributes

+ type CounterSubstitution struct

+ Hidden bool

+ Name string

+ Value interface{}

+ func NewCounterSubstitution(name string, hidden bool, val interface{}) (CounterSubstitution, error)

type DraftDocument

+ Attributes Attributes

+ type ElementPlaceHolder struct

+ Ref string

+ func NewElementPlaceHolder(ref string) (ElementPlaceHolder, error)

+ func (p ElementPlaceHolder) String() string

+ type ElementRole []interface

+ type Icon struct

+ Attributes Attributes

+ Class string

+ func NewIcon(class string, attributes Attributes) (Icon, error)

+ type InlinePassthrough struct

+ Elements []interface{}

+ Kind PassthroughKind

+ func NewInlinePassthrough(kind PassthroughKind, elements []interface{}) (InlinePassthrough, error)

type Location

+ Path []interface{}

+ Scheme string

+ func (l Location) Stringify() string

+ func (l Location) WithPathPrefix(p interface{}) Location

type OrderedListItem

+ Style string

type OrderedListItemPrefix

+ Style string

+ type PredefinedAttribute AttributeSubstitution

+ type QuotedString struct

+ Elements []interface{}

+ Kind QuotedStringKind

+ func NewQuotedString(kind QuotedStringKind, elements []interface{}) (QuotedString, error)

+ type QuotedStringKind int

+ const DoubleQuote

+ const SingleQuote

type QuotedTextKind

+ const Marked

+ type RawDocument struct

+ Blocks []interface{}

+ FrontMatter FrontMatter

+ func NewRawDocument(frontMatter interface{}, blocks []interface{}) (RawDocument, error)

+ func (d RawDocument) Attributes() Attributes

+ type RawLine struct

+ Content string

+ func NewRawLine(content string) (RawLine, error)

+ type SpecialCharacter struct

+ Name string

+ func NewSpecialCharacter(name string) (SpecialCharacter, error)

type Table

+ Columns []TableColumn

+ type TableColumn struct

+ HAlign string

+ Style string

+ VAlign string

+ Width string

+ type ThematicBreak struct

+ func NewThematicBreak() (ThematicBreak, error)

+ type VerbatimLine struct

+ Callouts []Callout

+ Elements []interface{}

+ func NewVerbatimLine(elements []interface{}, callouts []interface{}) (VerbatimLine, error)

+ func (s VerbatimLine) IsEmpty() bool

v0.4.0

Apr 19, 2020

Changes in this version

+ const AttrDocType

+ const AttrNoFooter

+ const AttrNoHeader

+ const AttrSyntaxHighlighter

+ const InvalidFootnoteReference

+ var Predefined map[string]string

type DocumentAttributes

+ func (a DocumentAttributes) GetAuthors() []DocumentAuthor

type DocumentAttributesWithOverrides

+ func (a DocumentAttributesWithOverrides) All() DocumentAttributes

type ElementAttributes

+ func (a ElementAttributes) AddNonEmpty(key string, value interface{})

+ type FootnoteReference struct

+ Duplicate bool

+ ID int

+ Ref string

type Footnotes

+ func NewFootnotes() *Footnotes

+ func (f *Footnotes) Notes() []Footnote

+ func (f *Footnotes) Reference(note Footnote) FootnoteReference

type FootnotesContainer

+ ReplaceFootnotes func(existing *Footnotes) interface{}

type Metadata

+ Authors []DocumentAuthor

+ Revision DocumentRevision

type Paragraph

+ func (p Paragraph) ReplaceFootnotes(notes *Footnotes) interface{}

type Section

+ func (s Section) ReplaceFootnotes(notes *Footnotes) interface{}

v0.3.0

Mar 14, 2020

Changes in this version

+ const AttrAuthor

+ const AttrAuthors

+ const AttrLastUpdated

+ const AttrLevelOffset

+ const AttrLineNums

+ const AttrLineRanges

+ const AttrNumberingStyle

+ const AttrRevision

+ const AttrTableOfContents

+ const AttrTableOfContentsLevels

+ const AttrTagRanges

+ const DefaultIDPrefix

+ func Apply(source string, fs ...applyFunc) string

+ func FindFootnotes(content interface{}) (Footnotes, FootnoteReferences, error)

+ func Merge(elements ...interface{}) []interface

+ func NilSafe(elements []interface{}) []interface

+ func ReplaceNonAlphanumerics(elements []interface{}, replacement string) (string, error)

type BulletStyle

+ func (b BulletStyle) NextLevel(p BulletStyle) BulletStyle

+ type ConcealedIndexTerm struct

+ Term1 interface{}

+ Term2 interface{}

+ Term3 interface{}

+ func NewConcealedIndexTerm(term1, term2, term3 interface{}) (ConcealedIndexTerm, error)

+ type ContinuedListItemElement struct

+ Element interface{}

+ Offset int

+ func NewContinuedListItemElement(offset int, element interface{}) (ContinuedListItemElement, error)

+ type CurrentRanges map[string]*CurrentTagRange

+ type CurrentTagRange struct

+ EndLine int

+ StartLine int

type Document

+ func (d Document) Authors() ([]DocumentAuthor, bool)

+ func (d Document) Header() (Section, bool)

+ func (d Document) Revision() (DocumentRevision, bool)

+ func (d Document) Title() ([]interface{}, bool)

type DocumentAttributes

+ func (a DocumentAttributes) Delete(attr DocumentAttributeReset)

+ func (a DocumentAttributes) GetAsStringWithDefault(key, defaultValue string) string

+ type DocumentAttributesWithOverrides struct

+ Content map[string]interface{}

+ Overrides map[string]string

+ func (a DocumentAttributesWithOverrides) Add(key string, value interface{})

+ func (a DocumentAttributesWithOverrides) AddAll(attrs map[string]interface{})

+ func (a DocumentAttributesWithOverrides) Delete(key string)

+ func (a DocumentAttributesWithOverrides) GetAsString(key string) (string, bool)

+ func (a DocumentAttributesWithOverrides) GetAsStringWithDefault(key, defaultValue string) string

type DocumentElement

+ GetAttributes func() ElementAttributes

+ type DraftDocument struct

+ Blocks []interface{}

+ FrontMatter FrontMatter

+ func NewDraftDocument(frontMatter interface{}, blocks []interface{}) (DraftDocument, error)

+ func (d DraftDocument) DocumentAttributes() DocumentAttributes

type ElementAttributes

+ func NewInlineAttributes(attrs []interface{}) (ElementAttributes, error)

+ func NewLineRangesAttribute(ranges interface{}) (ElementAttributes, error)

+ func NewTagRangesAttribute(ranges []interface{}) (ElementAttributes, error)

+ func (a ElementAttributes) NilSafeSet(key string, value interface{})

+ type ExternalCrossReference struct

+ Label []interface{}

+ Location Location

+ func NewExternalCrossReference(location Location, attributes ElementAttributes) (ExternalCrossReference, error)

+ func (r ExternalCrossReference) ResolveLocation(attrs DocumentAttributesWithOverrides) ExternalCrossReference

+ type FileInclusion struct

+ Attributes ElementAttributes

+ Location Location

+ RawText string

+ func NewFileInclusion(location Location, attributes interface{}, rawtext string) (FileInclusion, error)

+ func (f *FileInclusion) LineRanges() (LineRanges, bool)

+ func (f *FileInclusion) TagRanges() (TagRanges, bool)

+ type FootnotesContainer interface

+ Footnotes func() (Footnotes, FootnoteReferences, error)

type ImageBlock

+ Location Location

+ func (b ImageBlock) ResolveLocation(attrs DocumentAttributesWithOverrides) ImageBlock

+ type IncludedFileEndTag struct

+ Value string

+ func NewIncludedFileEndTag(tag string) (IncludedFileEndTag, error)

+ type IncludedFileLine []interface

+ func (l IncludedFileLine) GetEndTag() (IncludedFileEndTag, bool)

+ func (l IncludedFileLine) GetStartTag() (IncludedFileStartTag, bool)

+ func (l IncludedFileLine) HasTag() bool

+ func NewIncludedFileLine(content []interface{}) (IncludedFileLine, error)

+ type IncludedFileStartTag struct

+ Value string

+ func NewIncludedFileStartTag(tag string) (IncludedFileStartTag, error)

+ type IndexTerm struct

+ Term []interface{}

+ func NewIndexTerm(term []interface{}) (IndexTerm, error)

type InlineImage

+ Location Location

+ func (i InlineImage) ResolveLocation(attrs DocumentAttributesWithOverrides) InlineImage

type InlineLink

+ Location Location

+ type InternalCrossReference struct

+ ID string

+ Label string

+ func NewInternalCrossReference(id string, label interface{}) (InternalCrossReference, error)

type LabeledList

+ func NewLabeledList(item LabeledListItem) *LabeledList

+ func (l *LabeledList) AddItem(item LabeledListItem)

+ func (l *LabeledList) LastItem() ListItem

type LabeledListItem

+ func (i LabeledListItem) GetAttributes() ElementAttributes

+ type LineRange struct

+ EndLine int

+ StartLine int

+ func NewLineRange(start, end int) (LineRange, error)

+ type LineRanges []LineRange

+ func NewLineRanges(ranges ...interface{}) LineRanges

+ func (r LineRanges) Len() int

+ func (r LineRanges) Less(i, j int) bool

+ func (r LineRanges) Match(line int) bool

+ func (r LineRanges) Swap(i, j int)

type List

+ LastItem func() ListItem

+ type Location struct

+ Elements []interface{}

+ func NewLocation(elements []interface{}) (Location, error)

+ func (l *Location) Resolve(attrs DocumentAttributesWithOverrides) Location

+ func (l Location) String() string

+ type MacroKind string

+ const BlockMacro

+ const InlineMacro

+ type Metadata struct

+ LastUpdated string

+ TableOfContents TableOfContents

+ Title string

type OrderedList

+ func NewOrderedList(item *OrderedListItem) *OrderedList

+ func (l *OrderedList) AddItem(item OrderedListItem)

+ func (l *OrderedList) LastItem() ListItem

type OrderedListItem

+ func (i OrderedListItem) GetAttributes() ElementAttributes

type Paragraph

+ func (p Paragraph) Footnotes() (Footnotes, FootnoteReferences, error)

type Preamble

+ func (p Preamble) HasContent() bool

type Section

+ Attributes ElementAttributes

+ func (s *Section) AddElement(e interface{})

+ func (s Section) Footnotes() (Footnotes, FootnoteReferences, error)

+ func (s Section) ResolveID(docAttributes DocumentAttributesWithOverrides) (Section, error)

type StringElement

+ func (s StringElement) String() string

+ type TableOfContents struct

+ Sections []ToCSection

+ type TableOfContentsPlaceHolder struct

+ type TagRange struct

+ Included bool

+ Name string

+ func NewTagRange(name string, included bool) (TagRange, error)

+ type TagRanges []TagRange

+ func NewTagRanges(ranges ...interface{}) (TagRanges, error)

+ func (tr TagRanges) Match(line int, currentRanges CurrentRanges) bool

+ type ToCSection struct

+ Children []ToCSection

+ ID string

+ Level int

+ Title string

type UnorderedList

+ func NewUnorderedList(item *UnorderedListItem) *UnorderedList

+ func (l *UnorderedList) AddItem(item UnorderedListItem)

+ func (l *UnorderedList) LastItem() ListItem

type UnorderedListItem

+ func (i UnorderedListItem) GetAttributes() ElementAttributes

+ type UserMacro struct

+ Attributes ElementAttributes

+ Kind MacroKind

+ Name string

+ RawText string

+ Value string

+ func NewInlineUserMacro(name, value string, attrs ElementAttributes, raw string) (UserMacro, error)

+ func NewUserMacroBlock(name string, value string, attrs ElementAttributes, raw string) (UserMacro, error)

v0.2.0

Feb 24, 2019

Changes in this version

+ const AttrCheckStyle

+ const AttrCustomID

+ const AttrIDPrefix

+ const AttrQandA

+ const AttrStart

+ type ContinuedListElement struct

+ Element interface{}

+ Offset int

+ func NewContinuedListElement(offset int, element interface{}) (ContinuedListElement, error)

type DelimitedBlock

+ Kind BlockKind

type DocumentAttributes

+ func (a DocumentAttributes) AddAll(attrs DocumentAttributes) DocumentAttributes

+ func (a DocumentAttributes) AddDeclaration(attr DocumentAttributeDeclaration)

+ func (a DocumentAttributes) HasTitle() bool

type ElementAttributes

+ func (a ElementAttributes) GetAsBool(key string) bool

+ type ElementWithAttributes interface

+ AddAttributes func(attributes ElementAttributes)

type LabeledList

+ func (l LabeledList) GetItems() []ListItem

type LabeledListItem

+ func (i *LabeledListItem) AddElement(element interface{})

+ func (i *LabeledListItem) SetElements(elements []interface{})

+ func (i LabeledListItem) GetElements() []interface{}

type List

+ GetItems func() []ListItem

type ListItem

+ AddElement func(interface{})

+ GetElements func() []interface{}

+ SetElements func([]interface{})

type OrderedList

+ func (l OrderedList) GetItems() []ListItem

type OrderedListItem

+ func (i *OrderedListItem) AddElement(element interface{})

+ func (i *OrderedListItem) SetElements(elements []interface{})

+ func (i OrderedListItem) GetElements() []interface{}

type QuotedText

+ Kind QuotedTextKind

type SingleLineComment

+ func (l SingleLineComment) AddAttributes(attributes ElementAttributes)

type UnorderedList

+ func (l UnorderedList) GetItems() []ListItem

type UnorderedListItem

+ CheckStyle UnorderedListItemCheckStyle

+ func (i *UnorderedListItem) AddElement(element interface{})

+ func (i *UnorderedListItem) SetElements(elements []interface{})

+ func (i UnorderedListItem) GetElements() []interface{}

+ type UnorderedListItemCheckStyle string

+ const Checked

+ const NoCheck

+ const Unchecked

v0.1.0

Jan 2, 2019

Changes in this version

+ const AttrAdmonitionKind

+ const AttrHardBreaks

+ const AttrID

+ const AttrImageAlt

+ const AttrImageHeight

+ const AttrImageTitle

+ const AttrImageWidth

+ const AttrInlineLink

+ const AttrInlineLinkText

+ const AttrKind

+ const AttrLanguage

+ const AttrLiteralBlockType

+ const AttrQuoteAuthor

+ const AttrQuoteTitle

+ const AttrRole

+ const AttrSource

+ const AttrTitle

+ const Comment

+ const DocumentAttrHardBreaks

+ const Example

+ const Fenced

+ const Listing

+ const Literal

+ const LiteralBlockWithAttribute

+ const LiteralBlockWithDelimiter

+ const LiteralBlockWithSpacesOnFirstLine

+ const Quote

+ const Sidebar

+ const Source

+ const Verse

+ func NewEscapedQuotedText(backslashes string, punctuation string, content []interface{}) ([]interface{}, error)

+ func NewListItemContent(content []interface{}) ([]interface{}, error)

+ func NewQuoteAttributes(kind, author, title string) (map[string]interface{}, error)

+ func None(content []interface{}) ([]interface{}, error)

+ func ResetFootnoteSequence()

+ func Verbatim(content []interface{}) ([]interface{}, error)

+ func WithAttributes(element interface{}, attributes []interface{}) (interface{}, error)

+ type AdmonitionKind string

+ const Caution

+ const Important

+ const Note

+ const Tip

+ const Unknown

+ const Warning

+ type BlankLine struct

+ func NewBlankLine() (BlankLine, error)

+ func (l BlankLine) AddAttributes(attributes ElementAttributes)

+ type BlockKind int

+ type BulletStyle string

+ const Dash

+ const FiveAsterisks

+ const FourAsterisks

+ const OneAsterisk

+ const ThreeAsterisks

+ const TwoAsterisks

+ const UnknownBulletStyle

+ type CrossReference struct

+ ID string

+ Label string

+ func NewCrossReference(id string, label interface{}) (CrossReference, error)

+ type DefaultAttribute func(map[string]interface{})

+ func WithNumberingStyle(t NumberingStyle) DefaultAttribute

+ type DelimitedBlock struct

+ Attributes ElementAttributes

+ Elements []interface{}

+ func NewDelimitedBlock(kind BlockKind, content []interface{}, substitution Substitution, ...) (DelimitedBlock, error)

+ func (b DelimitedBlock) AddAttributes(attributes ElementAttributes)

+ type Document struct

+ Attributes DocumentAttributes

+ ElementReferences ElementReferences

+ Elements []interface{}

+ FootnoteReferences FootnoteReferences

+ Footnotes Footnotes

+ func NewDocument(frontmatter, header interface{}, blocks []interface{}) (Document, error)

+ type DocumentAttributeDeclaration struct

+ Name string

+ Value string

+ func NewDocumentAttributeDeclaration(name string, value interface{}) (DocumentAttributeDeclaration, error)

+ func (d DocumentAttributeDeclaration) AddAttributes(attributes ElementAttributes)

+ type DocumentAttributeReset struct

+ Name string

+ func NewDocumentAttributeReset(attrName string) (DocumentAttributeReset, error)

+ func (r DocumentAttributeReset) AddAttributes(attributes ElementAttributes)

+ type DocumentAttributeSubstitution struct

+ Name string

+ func NewDocumentAttributeSubstitution(attrName string) (DocumentAttributeSubstitution, error)

+ type DocumentAttributes map[string]interface

+ func (a DocumentAttributes) Add(key string, value interface{})

+ func (a DocumentAttributes) AddAttribute(attr DocumentAttributeDeclaration)

+ func (a DocumentAttributes) AddNonEmpty(key string, value interface{})

+ func (a DocumentAttributes) GetAsString(key string) string

+ func (a DocumentAttributes) GetTOCLevels() (*int, error)

+ func (a DocumentAttributes) GetTitle() (SectionTitle, error)

+ func (a DocumentAttributes) Has(key string) bool

+ func (a DocumentAttributes) HasAuthors() bool

+ func (a DocumentAttributes) Reset(attr DocumentAttributeReset)

+ type DocumentAuthor struct

+ Email string

+ FirstName string

+ FullName string

+ Initials string

+ LastName string

+ MiddleName string

+ func NewDocumentAuthor(namePart1, namePart2, namePart3, emailAddress interface{}) (DocumentAuthor, error)

+ func NewDocumentAuthors(authors []interface{}) ([]DocumentAuthor, error)

+ func (a *DocumentAuthor) String() string

+ type DocumentElement interface

+ AddAttributes func(attributes ElementAttributes)

+ type DocumentHeader struct

+ Content DocumentAttributes

+ func NewDocumentHeader(header, authors, revision interface{}, otherAttributes []interface{}) (DocumentHeader, error)

+ type DocumentRevision struct

+ Revdate string

+ Revnumber string

+ Revremark string

+ func NewDocumentRevision(revnumber, revdate, revremark interface{}) (DocumentRevision, error)

+ func (r DocumentRevision) String() string

+ type ElementAttributes map[string]interface

+ func (a ElementAttributes) AddAll(attributes ElementAttributes)

+ func (a ElementAttributes) GetAsString(key string) string

+ func (a ElementAttributes) Has(key string) bool

+ func NewAdmonitionAttribute(k AdmonitionKind) (ElementAttributes, error)

+ func NewAttributeGroup(attributes []interface{}) (ElementAttributes, error)

+ func NewElementAttributes(attributes []interface{}, extras ...ElementAttributes) ElementAttributes

+ func NewElementID(id string) (ElementAttributes, error)

+ func NewElementRole(role string) (ElementAttributes, error)

+ func NewElementTitle(title string) (ElementAttributes, error)

+ func NewGenericAttribute(key string, value interface{}) (ElementAttributes, error)

+ func NewImageAttributes(alt, width, height interface{}, otherAttrs []interface{}) (ElementAttributes, error)

+ func NewInlineElementID(id string) (ElementAttributes, error)

+ func NewInlineLinkAttributes(text interface{}, otherAttrs []interface{}) (ElementAttributes, error)

+ func NewLiteralAttribute() (ElementAttributes, error)

+ func NewSourceAttributes(language string) (ElementAttributes, error)

+ type ElementReferences map[string]interface

+ type ElementReferencesCollector struct

+ ElementReferences ElementReferences

+ func NewElementReferencesCollector() *ElementReferencesCollector

+ func (c *ElementReferencesCollector) Visit(element Visitable) error

+ type Footnote struct

+ Elements InlineElements

+ ID int

+ Ref string

+ func NewFootnote(ref string, elements InlineElements) (Footnote, error)

+ func (f Footnote) Accept(v Visitor) error

+ type FootnoteReferences map[string]Footnote

+ type Footnotes []Footnote

+ func (f Footnotes) IndexOf(note Footnote) (int, bool)

+ type FootnotesCollector struct

+ FootnoteReferences FootnoteReferences

+ Footnotes Footnotes

+ func NewFootnotesCollector() *FootnotesCollector

+ func (c *FootnotesCollector) Visit(element Visitable) error

+ type FrontMatter struct

+ Content map[string]interface{}

+ func NewYamlFrontMatter(content string) (FrontMatter, error)

+ type ImageBlock struct

+ Attributes ElementAttributes

+ Path string

+ func NewImageBlock(path string, inlineAttributes ElementAttributes) (ImageBlock, error)

+ func (i ImageBlock) AddAttributes(attributes ElementAttributes)

+ type ImageMacro struct

+ Attributes ElementAttributes

+ Path string

+ func NewImageMacro(path string, attributes ElementAttributes) (ImageMacro, error)

+ type InlineElements []interface

+ func (e InlineElements) Accept(v Visitor) error

+ func NewInlineElements(elements ...interface{}) (InlineElements, error)

+ type InlineImage struct

+ Attributes ElementAttributes

+ Path string

+ func NewInlineImage(path string, attributes ElementAttributes) (InlineImage, error)

+ func (i InlineImage) AddAttributes(attributes ElementAttributes)

+ type InlineLink struct

+ Attributes ElementAttributes

+ URL string

+ func NewInlineLink(url string, attributes interface{}) (InlineLink, error)

+ func (l InlineLink) Text() string

+ type LabeledList struct

+ Attributes ElementAttributes

+ Items []LabeledListItem

+ func (l LabeledList) AddAttributes(attributes ElementAttributes)

+ type LabeledListItem struct

+ Attributes ElementAttributes

+ Elements []interface{}

+ Level int

+ Term string

+ func NewLabeledListItem(level int, term string, elements []interface{}) (LabeledListItem, error)

+ func (i *LabeledListItem) AddAttributes(attributes ElementAttributes)

+ func (i *LabeledListItem) AddChild(item interface{})

+ type LineBreak struct

+ func NewLineBreak() (LineBreak, error)

+ type List interface

+ func NewList(items []interface{}) (List, error)

+ type ListItem interface

+ AddChild func(interface{})

+ type ListItemContinuation struct

+ func NewListItemContinuation() (ListItemContinuation, error)

+ type LiteralBlock struct

+ Attributes ElementAttributes

+ Lines []string

+ func NewLiteralBlock(origin string, lines []interface{}, attributes ...interface{}) (LiteralBlock, error)

+ func (b LiteralBlock) AddAttributes(attributes ElementAttributes)

+ type NormalizationFunc func(string) ([]byte, error)

+ type NumberingStyle string

+ const Arabic

+ const Decimal

+ const LowerAlpha

+ const LowerGreek

+ const LowerRoman

+ const UnknownNumberingStyle

+ const UpperAlpha

+ const UpperGreek

+ const UpperRoman

+ type OrderedList struct

+ Attributes ElementAttributes

+ Items []OrderedListItem

+ func (o OrderedList) AddAttributes(attributes ElementAttributes)

+ type OrderedListItem struct

+ Attributes ElementAttributes

+ Elements []interface{}

+ Level int

+ NumberingStyle NumberingStyle

+ Position int

+ func NewOrderedListItem(prefix OrderedListItemPrefix, elements []interface{}, attributes []interface{}) (OrderedListItem, error)

+ func (i *OrderedListItem) AddAttributes(attributes ElementAttributes)

+ func (i *OrderedListItem) AddChild(item interface{})

+ type OrderedListItemPrefix struct

+ Level int

+ NumberingStyle NumberingStyle

+ func NewOrderedListItemPrefix(s NumberingStyle, l int) (OrderedListItemPrefix, error)

+ type Paragraph struct

+ Attributes ElementAttributes

+ Lines []InlineElements

+ func NewAdmonitionParagraph(lines []interface{}, admonitionKind AdmonitionKind, attributes ...interface{}) (Paragraph, error)

+ func NewParagraph(lines []interface{}, attributes ...interface{}) (Paragraph, error)

+ func (p Paragraph) Accept(v Visitor) error

+ func (p Paragraph) AddAttributes(attributes ElementAttributes)

+ type Passthrough struct

+ Elements InlineElements

+ Kind PassthroughKind

+ func NewPassthrough(kind PassthroughKind, elements []interface{}) (Passthrough, error)

+ type PassthroughKind int

+ const PassthroughMacro

+ const SinglePlusPassthrough

+ const TriplePlusPassthrough

+ type Preamble struct

+ Elements []interface{}

+ func NewEmptyPreamble() Preamble

+ func (p Preamble) Accept(v Visitor) error

+ type QuotedText struct

+ Attributes ElementAttributes

+ Elements InlineElements

+ func NewQuotedText(kind QuotedTextKind, content []interface{}) (QuotedText, error)

+ func (t QuotedText) Accept(v Visitor) error

+ type QuotedTextKind int

+ const Bold

+ const Italic

+ const Monospace

+ const Subscript

+ const Superscript

+ type Section struct

+ Elements []interface{}

+ Level int

+ Title SectionTitle

+ func NewSection(level int, sectionTitle SectionTitle, blocks []interface{}) (Section, error)

+ func (s Section) Accept(v Visitor) error

+ func (s Section) AddAttributes(attributes ElementAttributes)

+ type SectionTitle struct

+ Attributes ElementAttributes

+ Elements InlineElements

+ func NewSectionTitle(elements InlineElements, ids []interface{}) (SectionTitle, error)

+ func (st SectionTitle) Accept(v Visitor) error

+ func (st SectionTitle) AddAttributes(attributes ElementAttributes)

+ type SingleLineComment struct

+ Content string

+ func NewSingleLineComment(content string) (SingleLineComment, error)

+ type StringElement struct

+ Content string

+ func NewStringElement(content string) StringElement

+ func (s StringElement) Accept(v Visitor) error

+ type Substitution func([]interface{}) ([]interface{}, error)

+ type Table struct

+ Attributes ElementAttributes

+ Header TableLine

+ Lines []TableLine

+ func NewTable(header interface{}, lines []interface{}) (Table, error)

+ func (t Table) AddAttributes(attributes ElementAttributes)

+ type TableLine struct

+ Cells []InlineElements

+ func NewTableLine(columns []interface{}) (TableLine, error)

+ type TableOfContentsMacro struct

+ func (m TableOfContentsMacro) AddAttributes(attributes ElementAttributes)

+ type UnorderedList struct

+ Attributes ElementAttributes

+ Items []UnorderedListItem

+ func (l UnorderedList) AddAttributes(attributes ElementAttributes)

+ type UnorderedListItem struct

+ Attributes ElementAttributes

+ BulletStyle BulletStyle

+ Elements []interface{}

+ Level int

+ func NewUnorderedListItem(prefix UnorderedListItemPrefix, elements []interface{}) (UnorderedListItem, error)

+ func (i *UnorderedListItem) AddAttributes(attributes ElementAttributes)

+ func (i *UnorderedListItem) AddChild(item interface{})

+ type UnorderedListItemPrefix struct

+ BulletStyle BulletStyle

+ Level int

+ func NewUnorderedListItemPrefix(s BulletStyle, l int) (UnorderedListItemPrefix, error)

+ type Visitable interface

+ Accept func(Visitor) error

+ type Visitor interface

+ Visit func(Visitable) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL