flydown

Documentation

Index

• func ConvertMdStrToHTML(mdStr string) string
• func MainHandleFunc(w http.ResponseWriter, r *http.Request)
• func RenderMdHandleFunc(w http.ResponseWriter, r *http.Request)
• func SearchHandleFunc(w http.ResponseWriter, r *http.Request)
• type Generator
  • func (generator *Generator) EnableVerbose()
  • func (generator *Generator) FindReadme() error
  • func (generator *Generator) FindSummary() error
  • func (generator *Generator) Init(flydownDataFolder string, rootMdFolder string, bookName string) error
  • func (generator *Generator) NewMarkdownFromFile(filename string) (result *Markdown, err error)
• type Markdown
  • func NewMarkdown(mdByteArray []byte) (result Markdown)

Functions

func ConvertMdStrToHTML

func ConvertMdStrToHTML(mdStr string) string

ConvertMdStrToHTML simply convert markdown string to html string

func MainHandleFunc

func MainHandleFunc(w http.ResponseWriter, r *http.Request)

MainHandleFunc handler to host the main page with summary on the left side and markdown on the right

func RenderMdHandleFunc

func RenderMdHandleFunc(w http.ResponseWriter, r *http.Request)

RenderMdHandleFunc handler to host markdown as html page on the fly

func SearchHandleFunc

func SearchHandleFunc(w http.ResponseWriter, r *http.Request)

SearchHandleFunc handler for searching request

Types

type Generator

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

Generator is a struct that keeps common settings for markdown generator

var MdGenerator Generator

MdGenerator is a main markdown generator structure

func (*Generator) EnableVerbose

func (generator *Generator) EnableVerbose()

EnableVerbose enables verbose mode for generator

func (*Generator) FindReadme

func (generator *Generator) FindReadme() error

FindReadme finds and stores readme filename

func (*Generator) FindSummary

func (generator *Generator) FindSummary() error

FindSummary finds and stores summary filename

func (*Generator) Init

func (generator *Generator) Init(flydownDataFolder string, rootMdFolder string, bookName string) error

Init initialize new generator

func (*Generator) NewMarkdownFromFile

func (generator *Generator) NewMarkdownFromFile(filename string) (result *Markdown, err error)

NewMarkdownFromFile create Markdown struct from file

type Markdown

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

Markdown is a base structure

func NewMarkdown

func NewMarkdown(mdByteArray []byte) (result Markdown)

NewMarkdown create the new Markdown structure