markdown

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2015 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

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.

Jump to

Keyboard shortcuts

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