Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bold ¶
type Bold struct {
// contains filtered or unexported fields
}
<strong></strong>, bold text
type CodeBlock ¶
type CodeBlock struct {
// contains filtered or unexported fields
}
<pre><code></code></pre>, contains plaintext and whitespaces, which MUST to be respec
type CodeInline ¶
type CodeInline struct {
// contains filtered or unexported fields
}
<code></code>, inline code element, contains plain text
func (CodeInline) String ¶
func (p CodeInline) String() string
type Heading ¶
type Heading struct {
// contains filtered or unexported fields
}
any of h1,h2,h3,h4,h5,h6, suffix is denoted using the lvl field
type Image ¶
type Image struct {
// contains filtered or unexported fields
}
<img src="" alt="">, image with alt and src
type Italic ¶
type Italic struct {
// contains filtered or unexported fields
}
<em></em>, italic text
type Link ¶
type Link struct {
// contains filtered or unexported fields
}
<a href=""></a>, anchor with href and title
type List ¶
type List struct {
// contains filtered or unexported fields
}
<ul></ul>, contains ListItem
type ListItem ¶
type ListItem struct {
// contains filtered or unexported fields
}
<li></li>, can contain almost everything else
type Paragraph ¶
type Paragraph struct {
// contains filtered or unexported fields
}
<p></p> html paragraph
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
func (*Parser) GenerateToc ¶
generates a toc, but only if '--toc' is specified, by default only generates the toc out of headings from h1 to h3. If the user specifies the '--toc-full' option the h4,h5 and h6 headings are considered.
type Quote ¶
type Quote struct {
// contains filtered or unexported fields
}
<blockquote></blockquote>, can contain all the other elements
type StrikeThrough ¶
type StrikeThrough struct {
// contains filtered or unexported fields
}
func (StrikeThrough) String ¶
func (p StrikeThrough) String() string
type Tag ¶
type Tag interface {
String() string
}
generic interface, allows us to return nil and all the implementing structs in the parser
type TodoListItem ¶
type TodoListItem struct {
// contains filtered or unexported fields
}
listitem but with a prefixed disabled checkmark
func (TodoListItem) String ¶
func (p TodoListItem) String() string
Source Files