Documentation

Overview

    Package markdown provides a Markdown renderer.

    Example
    Output:
    
    Title
    =====
    
    This is a new paragraph. I wonder if I have too many spaces. What about new paragraph. But the next one...
    
    Is really new.
    
    1.	Item one.
    2.	Item TWO.
    
    Final paragraph.
    
    Example (Two)
    Output:
    
    Title
    =====
    
    Subtitle
    --------
    
    How about `this` and other stuff like *italic*, **bold** and ***super extra***.
    

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func NewRenderer

    func NewRenderer(opt *Options) blackfriday.Renderer

      NewRenderer returns a Markdown renderer. If opt is nil the defaults are used.

      func Process

      func Process(filename string, src []byte, opt *Options) ([]byte, error)

        Process formats Markdown. If opt is nil the defaults are used. Error can only occur when reading input from filename rather than src.

        Types

        type Options

        type Options struct {
        	// Terminal specifies if ANSI escape codes are emitted for styling.
        	Terminal bool
        }

          Options specifies options for formatting.

          Source Files