markdown

package

Go to main page

Versions in this module

v0

v0.8.3

Apr 26, 2016

Changes in this version

type Data

+ func (d Data) Include(filename string) (string, error)

v0.8.2

Feb 25, 2016

Changes in this version

type Data

+ DocFlags map[string]bool

type Metadata

+ Flags map[string]bool

v0.8.1

Jan 12, 2016

v0.8.0

Dec 4, 2015

Changes in this version

+ type Data struct

+ Doc map[string]string

+ Links []PageLink

v0.7.6

Sep 28, 2015

v0.7.5

Aug 5, 2015

Changes in this version

+ const DefaultInterval

+ func GenerateStatic(md Markdown, cfg *Config) error

+ func TickerFunc(interval time.Duration, f func()) chan struct

+ func Watch(md Markdown, c *Config, interval time.Duration) (stopChan chan struct{})

type Config

+ Development bool

+ func (c Config) IsValidExt(ext string) bool

+ type SummaryRenderer struct

+ func (r SummaryRenderer) AutoLink(out *bytes.Buffer, link []byte, kind int)

+ func (r SummaryRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string)

+ func (r SummaryRenderer) BlockHtml(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) BlockQuote(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) CodeSpan(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) DocumentFooter(out *bytes.Buffer)

+ func (r SummaryRenderer) DocumentHeader(out *bytes.Buffer)

+ func (r SummaryRenderer) DoubleEmphasis(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) Emphasis(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) Entity(out *bytes.Buffer, entity []byte)

+ func (r SummaryRenderer) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int)

+ func (r SummaryRenderer) FootnoteRef(out *bytes.Buffer, ref []byte, id int)

+ func (r SummaryRenderer) Footnotes(out *bytes.Buffer, text func() bool)

+ func (r SummaryRenderer) GetFlags() int

+ func (r SummaryRenderer) HRule(out *bytes.Buffer)

+ func (r SummaryRenderer) Header(out *bytes.Buffer, text func() bool, level int, id string)

+ func (r SummaryRenderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

+ func (r SummaryRenderer) LineBreak(out *bytes.Buffer)

+ func (r SummaryRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

+ func (r SummaryRenderer) List(out *bytes.Buffer, text func() bool, flags int)

+ func (r SummaryRenderer) ListItem(out *bytes.Buffer, text []byte, flags int)

+ func (r SummaryRenderer) NormalText(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) Paragraph(out *bytes.Buffer, text func() bool)

+ func (r SummaryRenderer) RawHtmlTag(out *bytes.Buffer, tag []byte)

+ func (r SummaryRenderer) StrikeThrough(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)

+ func (r SummaryRenderer) TableCell(out *bytes.Buffer, text []byte, flags int)

+ func (r SummaryRenderer) TableHeaderCell(out *bytes.Buffer, text []byte, flags int)

+ func (r SummaryRenderer) TableRow(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) TitleBlock(out *bytes.Buffer, text []byte)

+ func (r SummaryRenderer) TripleEmphasis(out *bytes.Buffer, text []byte)

v0.7.4

Jul 30, 2015

Changes in this version

+ func GenerateLinks(md Markdown, cfg *Config) error

type Config

+ Links []PageLink

+ type MarkdownData struct

+ Doc map[string]string

+ Links []PageLink

type Metadata

+ Date time.Time

+ type PageLink struct

+ Date time.Time

+ Summary string

+ Title string

+ URL string

+ type PlaintextRenderer struct

+ func (r PlaintextRenderer) AutoLink(out *bytes.Buffer, link []byte, kind int)

+ func (r PlaintextRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string)

+ func (r PlaintextRenderer) BlockHtml(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) BlockQuote(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) CodeSpan(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) DocumentFooter(out *bytes.Buffer)

+ func (r PlaintextRenderer) DocumentHeader(out *bytes.Buffer)

+ func (r PlaintextRenderer) DoubleEmphasis(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) Emphasis(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) Entity(out *bytes.Buffer, entity []byte)

+ func (r PlaintextRenderer) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int)

+ func (r PlaintextRenderer) FootnoteRef(out *bytes.Buffer, ref []byte, id int)

+ func (r PlaintextRenderer) Footnotes(out *bytes.Buffer, text func() bool)

+ func (r PlaintextRenderer) GetFlags() int

+ func (r PlaintextRenderer) HRule(out *bytes.Buffer)

+ func (r PlaintextRenderer) Header(out *bytes.Buffer, text func() bool, level int, id string)

+ func (r PlaintextRenderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

+ func (r PlaintextRenderer) LineBreak(out *bytes.Buffer)

+ func (r PlaintextRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

+ func (r PlaintextRenderer) List(out *bytes.Buffer, text func() bool, flags int)

+ func (r PlaintextRenderer) ListItem(out *bytes.Buffer, text []byte, flags int)

+ func (r PlaintextRenderer) NormalText(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) Paragraph(out *bytes.Buffer, text func() bool)

+ func (r PlaintextRenderer) RawHtmlTag(out *bytes.Buffer, tag []byte)

+ func (r PlaintextRenderer) StrikeThrough(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)

+ func (r PlaintextRenderer) TableCell(out *bytes.Buffer, text []byte, flags int)

+ func (r PlaintextRenderer) TableHeaderCell(out *bytes.Buffer, text []byte, flags int)

+ func (r PlaintextRenderer) TableRow(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) TitleBlock(out *bytes.Buffer, text []byte)

+ func (r PlaintextRenderer) TripleEmphasis(out *bytes.Buffer, text []byte)

v0.7.3

Jul 15, 2015

v0.7.2

Jul 1, 2015

v0.7.1

Jun 2, 2015

v0.7.0

May 25, 2015

Changes in this version

+ const DefaultStaticDir

+ const DefaultTemplate

type Config

+ StaticDir string

+ StaticFiles map[string]string

+ Templates map[string]string

+ type JSONMetadataParser struct

+ func (j *JSONMetadataParser) Closing() []byte

+ func (j *JSONMetadataParser) Metadata() Metadata

+ func (j *JSONMetadataParser) Opening() []byte

+ func (j *JSONMetadataParser) Parse(b []byte) ([]byte, error)

type Markdown

+ func (md Markdown) IsIndexFile(file string) bool

+ func (md Markdown) Process(c Config, requestPath string, b []byte) ([]byte, error)

+ type Metadata struct

+ Template string

+ Title string

+ Variables map[string]interface{}

+ type MetadataParser interface

+ Closing func() []byte

+ Metadata func() Metadata

+ Opening func() []byte

+ Parse func([]byte) ([]byte, error)

+ type TOMLMetadataParser struct

+ func (t *TOMLMetadataParser) Closing() []byte

+ func (t *TOMLMetadataParser) Metadata() Metadata

+ func (t *TOMLMetadataParser) Opening() []byte

+ func (t *TOMLMetadataParser) Parse(b []byte) ([]byte, error)

+ type YAMLMetadataParser struct

+ func (y *YAMLMetadataParser) Closing() []byte

+ func (y *YAMLMetadataParser) Metadata() Metadata

+ func (y *YAMLMetadataParser) Opening() []byte

+ func (y *YAMLMetadataParser) Parse(b []byte) ([]byte, error)

v0.6.0

May 6, 2015

Changes in this version

+ type Config struct

+ Extensions []string

+ PathScope string

+ Renderer blackfriday.Renderer

+ Scripts []string

+ Styles []string

type Markdown

+ FileSys http.FileSystem

+ IndexFiles []string

v0.5.1

Apr 30, 2015

v0.5.0

Apr 28, 2015

Changes in this version

+ func New(c middleware.Controller) (middleware.Middleware, error)

+ type Markdown struct

+ Configs []MarkdownConfig

+ Next middleware.Handler

+ Root string

+ func (md Markdown) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

+ type MarkdownConfig struct

+ Extensions []string

+ PathScope string

+ Renderer blackfriday.Renderer

+ Scripts []string

+ Styles []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL