Documentation

Overview

    Package syntax generates syntax highlighting for preformatted code blocks using the "chroma" processor. All of the themes and styles from the processor are directly exposed through the plugin interface.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Placement

    type Placement int
    const (
    	PlaceInside Placement = iota
    	PlaceInline
    )

    type Syntax

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

      Syntax chainable context.

      func New

      func New() *Syntax

        New creates a new instance of the Syntax plugin.

        func (*Syntax) Initialize

        func (*Syntax) Initialize(context *goldsmith.Context) error

        func (*Syntax) LineNumbers

        func (plugin *Syntax) LineNumbers(numbers bool) *Syntax

          LineNumbers sets the visibility of a line number gutter next to the code (default: false).

          func (*Syntax) Name

          func (*Syntax) Name() string

          func (*Syntax) Placement

          func (plugin *Syntax) Placement(placement Placement) *Syntax

            Placement determines if code should replace the containing block or be placed inside of it (default: "PlaceInside").

            func (*Syntax) Prefix

            func (plugin *Syntax) Prefix(prefix string) *Syntax

              Prefix sets the CSS class name prefix for code language identification (default: "language-").

              func (*Syntax) Process

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

              func (*Syntax) Style

              func (plugin *Syntax) Style(style string) *Syntax

                Style sets the color scheme used for syntax highlighting (default: "github"). Additional styles can be found at: https://github.com/alecthomas/chroma/tree/master/styles.

                Source Files