document

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
• type Document
  • func New(s string) (*Document, error)
  • 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

Functions

func CleanToLower

func CleanToLower(s string) string

func Normalize

func Normalize(s string) string

Types

type Document

type Document struct {
	// contains filtered or unexported fields
}

func New

func New(s string) (*Document, error)

New parses a markdown+ text string and returnes a Document object.

func (*Document) Data

func (doc *Document) Data() *ogdl.Graph

Data returns the Document as OGDL data

func (*Document) Html

func (doc *Document) Html() string

Html returnes the Document in HTML format

func (*Document) HtmlNoHeader

func (doc *Document) HtmlNoHeader() string

Html returnes the Document in HTML format, but skip the first header

func (*Document) HtmlWithLinks

func (doc *Document) HtmlWithLinks(urlbase string) string

Html returnes the Document in HTML format

func (*Document) Para1

func (doc *Document) Para1() string

Return the first paragraph of this document

func (*Document) Part

func (doc *Document) Part(path string) *Document

Part returns the part of the document indicated by the given path.

func (*Document) Raw

func (doc *Document) Raw() *ogdl.Graph