Documentation

Overview

Package markdown renders Markdown documents to HTML with the "goldmark" processor. 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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Markdown

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

Markdown chainable context.

func New

func New() *Markdown

New creates a new instance of the Markdown plugin.

func NewWithGoldmark

func NewWithGoldmark(md goldmark.Markdown) *Markdown

New creates a new instance of the Markdown plugin with user-provided goldmark instance.

func (*Markdown) Initialize

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

func (*Markdown) Name

func (*Markdown) Name() string

func (*Markdown) Process

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

Source Files