markdown

package module

v0.1.6 Latest Latest Go to latest Published: Jun 27, 2022 License: MIT Imports: 24 Imported by: 0

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/crgimenes/term-markdown

Links

Open Source Insights

README ¶

term-markdown

This is a heavily modified version of the go-term-markdown package at https://github.com/MichaelMure/go-term-markdown so please consider using the original version.

Documentation ¶

Index ¶

Constants
Variables
func Extensions() parser.Extensions
func NewRenderer(lineWidth int, leftPad int, opts ...Options) *renderer
func Render(source string, lineWidth int, leftPad int, opts ...Options) []byte
type CellAlign
type DitheringMode
type Options

Constants ¶

View Source

const (
	NoDithering = DitheringMode(iota)
	DitheringWithBlocks
	DitheringWithChars
)

Variables ¶

View Source

var (
	Green        = color.New(color.FgGreen).SprintFunc()
	HiGreen      = color.New(color.FgHiGreen).SprintFunc()
	GreenBold    = color.New(color.FgGreen, color.Bold).SprintFunc()
	Blue         = color.New(color.FgBlue).SprintFunc()
	BlueBgItalic = color.New(color.BgBlue, color.Italic).SprintFunc()
	Red          = color.New(color.FgRed).SprintFunc()
)

Functions ¶

func Extensions ¶

func Extensions() parser.Extensions

Extensions returns the bitmask of extensions supported by this renderer. The output of this function can be used to instantiate a new markdown parser using the `NewWithExtensions` function.

func NewRenderer ¶

func NewRenderer(lineWidth int, leftPad int, opts ...Options) *renderer

/ NewRenderer creates a new instance of the console renderer

func Render ¶

func Render(source string, lineWidth int, leftPad int, opts ...Options) []byte

Types ¶

type CellAlign ¶

type CellAlign int

const (
	CellAlignLeft CellAlign = iota
	CellAlignRight
	CellAlignCenter
	CellAlignCopyHeader
)

type DitheringMode ¶

type DitheringMode uint8

DitheringMode type is used for image scale dithering mode constants.

type Options ¶

type Options func(r *renderer)

func WithBlockquoteShades ¶

func WithBlockquoteShades(shades []shadeFmt) Options

Use a custom collection of ANSI colors for the blockquotes

func WithHeadingShades ¶

func WithHeadingShades(shades []shadeFmt) Options

Use a custom collection of ANSI colors for the headings

func WithImageDithering ¶

func WithImageDithering(mode DitheringMode) Options

Dithering mode for ansimage Default is fine directly through a terminal DitheringWithBlocks is recommended if a terminal UI library is used

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
debug
fuzzing
html
misc

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