Documentation
¶
Overview ¶
A markdown processor. Converts markdown to an internal format that may be rendered later as HTML or treated as data
The markdown does follow mostly the de-facto rules, but not all.
Index ¶
- func CleanToLower(s string) string
- func Normalize(s string) string
- func ToScreamingDelimited(s string, delimiter uint8, ignore string, screaming bool) string
- type Document
- func (doc *Document) CompareStructure(ref *Document) (bool, string)
- func (doc *Document) Data() *ogdl.Graph
- func (doc *Document) Html() string
- func (doc *Document) HtmlNoHeader() string
- func (doc *Document) HtmlWithLinks(urlbase string) string
- func (doc *Document) Para1() string
- func (doc *Document) Part(path string) *Document
- func (doc *Document) Raw() *ogdl.Graph
- func (doc *Document) Structure() *ogdl.Graph
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CleanToLower ¶
func ToScreamingDelimited ¶
ToScreamingDelimited converts a string to SCREAMING.DELIMITED.SNAKE.CASE (in this case `delimiter = '.'; screaming = true`) or delimited.snake.case (in this case `delimiter = '.'; screaming = false`)
Types ¶
type Document ¶
type Document struct {
// contains filtered or unexported fields
}
func (*Document) CompareStructure ¶
Compare the structure of two documents. All headers of ref need to be in doc. Order is not important, but nesting is.
func (*Document) HtmlNoHeader ¶
Html returnes the Document in HTML format, but skip the first header
func (*Document) HtmlWithLinks ¶
Html returnes the Document in HTML format
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.