parser

package
v2.0.2 Latest Latest
Warning

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

Go to latest
Published: Jan 12, 2026 License: GPL-3.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	// EnableCodeHighlighting controls whether ringfenced code blocks should be
	// highlighted or not
	EnableCodeHighlighting bool
	// CodeHighlightingStyle to use for ringfenced code blocks.
	//
	// Note that currently Chroma is used so you should refer to the styles in
	// their [documentation] and [source code]
	//
	// [documentation]: https://pkg.go.dev/github.com/alecthomas/chroma
	// [source code]: https://github.com/alecthomas/chroma/tree/master/styles
	CodeHighlightingStyle string

	// EnableFootnote controls whether the parser should allow the use of PHP
	// Markdown Extra Footnotes.
	EnableFootnote bool
}

Config contains all the options for the Parser to use when reading and parsing markdown files.

Jump to

Keyboard shortcuts

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