chroma

package

v0.12.1 Latest Latest Go to latest Published: Dec 29, 2021 License: MIT Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vito/booklit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package chroma provides a basic plugin for implementing syntax highlighting using Chroma (https://github.com/alecthomas/chroma).

To use this plugin, pass `--plugin github.com/vito/booklit/chroma/plugin` and use it like so:

\use-plugin{chroma}

\syntax{go}{{{
package chroma

// ...
}}}

An optional style name may be specified as the third argument. To use a custom style you may write your own plugin that embeds this plugin, or re-assign github.com/alecthomas/chroma/styles.Fallback to change the default.

Index ¶

Variables
func NewPlugin(section *booklit.Section) booklit.Plugin
type Plugin
- func (plugin Plugin) Syntax(language string, code booklit.Content, styleName ...string) (booklit.Content, error)
- func (plugin Plugin) SyntaxTransform(language string, code booklit.Content, chromaStyle *chroma.Style, ...) (booklit.Content, error)
type Transformer
- func (t Transformer) TransformAll(str string) booklit.Sequence

Constants ¶

This section is empty.

Variables ¶

View Source

var Booklit = lexers.Register(MustNewLexer(
	&Config{
		Name:      "Booklit",
		Aliases:   []string{"booklit"},
		Filenames: []string{"*.lit"},
		MimeTypes: []string{"text/x-booklit"},
	},
	Rules{
		"root": {
			{`[^\\{}]+`, Text, nil},
			{`\{\{\{`, StringDouble, Push("verbatim")},
			{`\{-`, CommentMultiline, Push("comment")},
			{`[{}]`, NameBuiltin, nil},
			{`\\([a-z-]+)`, Keyword, nil},
			{`\\[\\{}]+`, Text, nil},
		},
		"verbatim": {
			{`\}\}\}`, StringDouble, Pop(1)},
			{`[^}]+`, StringDouble, nil},
			{`}[^\}]`, StringDouble, nil},
		},
		"comment": {
			{`[^-{}]+`, CommentMultiline, nil},
			{`\{-`, CommentMultiline, Push()},
			{`-\}`, CommentMultiline, Pop(1)},
			{`[-{}]`, CommentMultiline, nil},
		},
	},
))

Booklit is a lexer for Booklit syntax.

Functions ¶

func NewPlugin ¶

func NewPlugin(section *booklit.Section) booklit.Plugin

Types ¶

type Plugin ¶

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

func (Plugin) Syntax ¶

func (plugin Plugin) Syntax(language string, code booklit.Content, styleName ...string) (booklit.Content, error)

func (Plugin) SyntaxTransform ¶ added in v0.12.0

func (plugin Plugin) SyntaxTransform(language string, code booklit.Content, chromaStyle *chroma.Style, transformers ...Transformer) (booklit.Content, error)

type Transformer ¶ added in v0.12.0

type Transformer struct {
	Pattern   *regexp.Regexp
	Transform func(string) booklit.Content
}

func (Transformer) TransformAll ¶ added in v0.12.0

func (t Transformer) TransformAll(str string) booklit.Sequence

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
plugin

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