markdown

Documentation

Overview

Package markdown is middleware to render markdown files as HTML on-the-fly.

Index

• func New(c middleware.Controller) (middleware.Middleware, error)
• type Markdown
  • func (md Markdown) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type MarkdownConfig

Functions

func New

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

New creates a new instance of Markdown middleware that renders markdown to HTML on-the-fly.

Types

type Markdown

type Markdown struct {
	// Server root
	Root string

	// Next HTTP handler in the chain
	Next middleware.Handler

	// The list of markdown configurations
	Configs []MarkdownConfig
}

Markdown implements a layer of middleware that serves markdown as HTML.

func (Markdown) ServeHTTP

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

ServeHTTP implements the http.Handler interface.

type MarkdownConfig

type MarkdownConfig struct {
	// Markdown renderer
	Renderer blackfriday.Renderer

	// Base path to match
	PathScope string

	// List of extensions to consider as markdown files
	Extensions []string

	// List of style sheets to load for each markdown file
	Styles []string

	// List of JavaScript files to load for each markdown file
	Scripts []string
}

MarkdownConfig stores markdown middleware configurations.