Documentation
¶
Overview ¶
Package markdown renders markdown as styled terminal text.
Almost everything a terminal application shows that a person wrote is markdown — a description, a comment, a release note — and showing it raw means showing the syntax instead of the emphasis. This is one renderer, cached by width, for all of it.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Renderer ¶
type Renderer struct {
// contains filtered or unexported fields
}
Renderer lays out markdown at a width, keeping the renderer it built.
The zero value is ready to use, and Default is the one most applications want: building a renderer parses the whole style definition, which is far too much work to repeat on a keystroke-triggered redraw.
var Default Renderer
Default is the shared renderer. An application that wants a different style for one pane makes its own.
Source Files
Click to show internal directories.
Click to hide internal directories.