Documentation
¶
Overview ¶
escape and parse markdown elements
Index ¶
- Constants
- func EscapeString(msg string) string
- type Cleaner
- func (c *Cleaner) Close()
- func (c *Cleaner) Write(msg []byte) (n int, err error)
- func (c *Cleaner) WriteEscaped(msg []byte) (n int, err error)
- func (c *Cleaner) WriteHeader(degree int, msg []byte) (n int, err error)
- func (c *Cleaner) WriteList(depth int, msg []byte) (n int, err error)
- func (c *Cleaner) WriteString(msg string) (n int, err error)
- func (c *Cleaner) WriteStringEscaped(msg string) (n int, err error)
- func (c *Cleaner) Writef(format string, args ...interface{}) (n int, err error)
- func (c *Cleaner) WritefEscaped(format string, args ...interface{}) (n int, err error)
- func (c *Cleaner) WritefHeader(degree int, format string, args ...interface{}) (n int, err error)
- func (c *Cleaner) WritefList(depth int, format string, args ...interface{}) (n int, err error)
- type Color
- type Image
- type Item
- type Lexer
- type Notifier
- type Url
Constants ¶
const ( NormalText byte = iota ColorCode ColorText ColorTextBold ColorTextUnderline ColorTextStrike ColorTextEmphasis UrlLink UrlText ImagePath ImageText ImageLink BoldText StrikeText EmphasisText UnderlineText ErrorText EOF )
const ( White = "white" Black = "black" Blue = "blue" Green = "green" Red = "red" Brown = "brown" Purple = "purple" Orange = "orange" Yellow = "yellow" LightGreen = "lightgreen" Cyan = "cyan" LightCyan = "lightcyan" LightBlue = "lightblue" Pink = "pink" Grey = "grey" LightGrey = "lightgrey" )
Variables ¶
This section is empty.
Functions ¶
func EscapeString ¶
EscapeString returns a properly escaped Altid markup string
Types ¶
type Cleaner ¶
type Cleaner struct {
// contains filtered or unexported fields
}
Cleaner represents a WriteCloser used to escape any altid markdown elements from a reader
func (*Cleaner) Close ¶
func (c *Cleaner) Close()
Close wraps the underlying WriteCloser's Close method
func (*Cleaner) Write ¶
Write call the underlying WriteCloser's Write method Write does not modify the contents of msg
func (*Cleaner) WriteEscaped ¶
WriteEscaped writes the properly escaped markdown to the underlying WriteCloser
func (*Cleaner) WriteHeader ¶
Variant of WriteEscaped which writes an nth degree markdown header element to the underlying WriteCloser
func (*Cleaner) WriteList ¶
Variant of WriteEscaped which adds an nth-nested markdown list element to the underlying WriteCloser
func (*Cleaner) WriteString ¶
WriteString is a variant of Write which accepts a string as input
func (*Cleaner) WriteStringEscaped ¶
Variant of WriteEscaped which accepts a string as input
func (*Cleaner) WritefEscaped ¶
Variant of WriteEscaped which accepts a format specifier
func (*Cleaner) WritefHeader ¶
Variant of WriteHeader which accepts a format specifier
type Color ¶
type Color struct {
// contains filtered or unexported fields
}
Color represents a color markdown element Valid values for code are any [markup constants], or color strings in hexidecimal form. #000000 to #FFFFFF, as well as #000 to #FFF. No alpha channel support currently exists.
type Image ¶
type Image struct {
// contains filtered or unexported fields
}
Image represents an image markdown element
type Lexer ¶
type Lexer struct {
// contains filtered or unexported fields
}
Lexer allows tokenizing of altid-flavored markdown for client-side parsers
func NewStringLexer ¶
func (*Lexer) Bytes ¶
Bytes wil return a parsed byte array from the input with markdown elements cleaned Any URL will be turned from `[some text](someurl)` to `some text (some url)` IMG will be turned from `` to `some text (some image)` color tags will be removed and the raw text will be output
type Notifier ¶
type Notifier struct {
// contains filtered or unexported fields
}
Notifier is a type provided for use with fslib's Notification function
func NewNotifier ¶
NewNotifier returns a notifier ready for parsing
type Url ¶ added in v0.1.0
Url represents a link markdown element
Source Files