termd

README

Termd

Package termd provides terminal markdown rendering, with code block syntax highlighting support.

Features

• Code block syntax highlighting (JSON-friendly for loading from user config)
• Word wrapping to the specified column width
• Terminal specific styling (still looks like markdown but it's cleaned up for the term)

---

Sponsors

This project is sponsored by CTO.ai, making it easy for development teams to create and share workflow automations without leaving the command line.

Documentation

Overview

Package termd provides terminal markdown rendering, with code block syntax highlighting support.

Example

var c termd.Compiler

c.SyntaxHighlighter = termd.SyntaxTheme{
	"keyword": termd.Style{},
	"comment": termd.Style{
		Color: "#323232",
	},
	"literal": termd.Style{
		Color: "#555555",
	},
	"name": termd.Style{
		Color: "#777777",
	},
	"name.function": termd.Style{
		Color: "#444444",
	},
	"literal.string": termd.Style{
		Color: "#333333",
	},
}

b, _ := ioutil.ReadFile("testdata/example.md")
fmt.Printf("%s\n", c.Compile(string(b)))

Index

• type Compiler
  • func (c *Compiler) Compile(s string) string
• type Style
• type SyntaxHighlighter
• type SyntaxTheme
  • func (c SyntaxTheme) Token(t chroma.Token) string

Examples

• Package

Types

type Compiler

type Compiler struct {
	// Columns is the number of columns to wrap text, defaulting to 90.
	Columns int

	// Markdown is an optional instance of a blackfriday markdown parser,
	// defaulting to one with CommonExtensions enabled.
	Markdown *blackfriday.Markdown

	// SyntaxHighlighter is an optional syntax highlighter for code blocks,
	// using the low-level SyntaxHighlighter interface, or SyntaxTheme map.
	SyntaxHighlighter
	// contains filtered or unexported fields
}

Compiler is the markdown to text compiler. The zero value can be used.

func (*Compiler) Compile

func (c *Compiler) Compile(s string) string

Compile returns a terminal-styled plain text representation of a markdown string.

type Style

type Style struct {
	Color      string `json:"color"`
	Background string `json:"background"`
	Bold       bool   `json:"bold"`
	Faint      bool   `json:"faint"`
	Italic     bool   `json:"italic"`
	Underline  bool   `json:"underline"`
}

Style is the configuration used to style a particular token.

type SyntaxHighlighter

type SyntaxHighlighter interface {
	Token(chroma.Token) string
}

SyntaxHighlighter is the interface used to highlight blocks of code.

type SyntaxTheme

type SyntaxTheme map[string]Style

SyntaxTheme is a map of token names to style configurations.

func (SyntaxTheme) Token

func (c SyntaxTheme) Token(t chroma.Token) string

Token implementation.