goldsmith-components: github.com/FooSoft/goldsmith-components/plugins/markdown Index | Files

package markdown

import "github.com/FooSoft/goldsmith-components/plugins/markdown"

Package markdown renders Markdown documents to HTML with the "blackfriday" processor. You can specify which Markdown extensions and HTML features to use by directly passing the blackfriday flags to this plugin. Note that unlike other static site generators, Markdown processing does not automatically parse frontmatter; you will need to use the "frontmatter" plugin to extract any metadata which may be present in your source content.

Index

Package Files

markdown.go

type Markdown Uses

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

Markdown chainable context.

func New Uses

func New() *Markdown

New creates a new instance of the Markdown plugin.

func (*Markdown) HtmlFlags Uses

func (plugin *Markdown) HtmlFlags(flags int) *Markdown

HtmlFlags sets the HTML flags used by the blackfriday markdown processor; see https://github.com/russross/blackfriday/blob/master/html.go for options.

func (*Markdown) Initialize Uses

func (plugin *Markdown) Initialize(context *goldsmith.Context) (goldsmith.Filter, error)

func (*Markdown) MarkdownFlags Uses

func (plugin *Markdown) MarkdownFlags(flags int) *Markdown

MarkdownFlags sets the markdown flags used by the blackfriday markdown processor; see https://github.com/russross/blackfriday/blob/master/markdown.go for options.

func (*Markdown) Name Uses

func (*Markdown) Name() string

func (*Markdown) Process Uses

func (plugin *Markdown) Process(context *goldsmith.Context, inputFile *goldsmith.File) error

Package markdown imports 6 packages (graph) and is imported by 1 packages. Updated 2019-04-08. Refresh now. Tools for package owners.