Versions in this module Expand all Collapse all v0 v0.0.2 Feb 1, 2024 Changes in this version + var ErrCreateMarkdownIndex = errors.New("markdown index can't be created") + var ErrInitMarkdownIndex = errors.New("markdown index can't be initialized") + var ErrMismatchColumn = errors.New("number of columns in the record doesn't match the header") + var ErrWriteMarkdownIndex = errors.New("markdown index can't be written") + func Bold(text string) string + func BoldItalic(text string) string + func Code(text string) string + func GenerateIndex(targetDir string, opts ...IndexOption) error + func Image(text, url string) string + func Italic(text string) string + func Link(text, url string) string + func Strikethrough(text string) string + type CheckBoxSet struct + Checked bool + Text string + type Index struct + type IndexOption func(*Index) error + func WithDescription(description []string) IndexOption + func WithTitle(title string) IndexOption + func WithWriter(w io.Writer) IndexOption + type Markdown struct + func NewMarkdown(w io.Writer) *Markdown + func (m *Markdown) Blockquote(text string) *Markdown + func (m *Markdown) Build() error + func (m *Markdown) BulletList(text ...string) *Markdown + func (m *Markdown) Caution(text string) *Markdown + func (m *Markdown) Cautionf(format string, args ...interface{}) *Markdown + func (m *Markdown) CheckBox(set []CheckBoxSet) *Markdown + func (m *Markdown) CodeBlocks(lang SyntaxHighlight, text string) *Markdown + func (m *Markdown) CustomTable(t TableSet, options TableOptions) *Markdown + func (m *Markdown) Details(summary, text string) *Markdown + func (m *Markdown) Detailsf(summary, format string, args ...interface{}) *Markdown + func (m *Markdown) Error() error + func (m *Markdown) GreenBadge(text string) *Markdown + func (m *Markdown) GreenBadgef(format string, args ...interface{}) *Markdown + func (m *Markdown) H1(text string) *Markdown + func (m *Markdown) H1f(format string, args ...interface{}) *Markdown + func (m *Markdown) H2(text string) *Markdown + func (m *Markdown) H2f(format string, args ...interface{}) *Markdown + func (m *Markdown) H3(text string) *Markdown + func (m *Markdown) H3f(format string, args ...interface{}) *Markdown + func (m *Markdown) H4(text string) *Markdown + func (m *Markdown) H4f(format string, args ...interface{}) *Markdown + func (m *Markdown) H5(text string) *Markdown + func (m *Markdown) H5f(format string, args ...interface{}) *Markdown + func (m *Markdown) H6(text string) *Markdown + func (m *Markdown) H6f(format string, args ...interface{}) *Markdown + func (m *Markdown) HorizontalRule() *Markdown + func (m *Markdown) Important(text string) *Markdown + func (m *Markdown) Importantf(format string, args ...interface{}) *Markdown + func (m *Markdown) LF() *Markdown + func (m *Markdown) Note(text string) *Markdown + func (m *Markdown) Notef(format string, args ...interface{}) *Markdown + func (m *Markdown) OrderedList(text ...string) *Markdown + func (m *Markdown) PlainText(text string) *Markdown + func (m *Markdown) PlainTextf(format string, args ...interface{}) *Markdown + func (m *Markdown) RedBadge(text string) *Markdown + func (m *Markdown) RedBadgef(format string, args ...interface{}) *Markdown + func (m *Markdown) String() string + func (m *Markdown) Table(t TableSet) *Markdown + func (m *Markdown) Tip(text string) *Markdown + func (m *Markdown) Tipf(format string, args ...interface{}) *Markdown + func (m *Markdown) Warning(text string) *Markdown + func (m *Markdown) Warningf(format string, args ...interface{}) *Markdown + func (m *Markdown) YellowBadge(text string) *Markdown + func (m *Markdown) YellowBadgef(format string, args ...interface{}) *Markdown + type SyntaxHighlight string + const SyntaxHighlightAPIBlueprint + const SyntaxHighlightApache + const SyntaxHighlightC + const SyntaxHighlightCPlusPlus + const SyntaxHighlightCSS + const SyntaxHighlightCSharp + const SyntaxHighlightClojure + const SyntaxHighlightCoffeeScript + const SyntaxHighlightDart + const SyntaxHighlightDiff + const SyntaxHighlightDockerfile + const SyntaxHighlightElixir + const SyntaxHighlightErlang + const SyntaxHighlightFSharp + const SyntaxHighlightGo + const SyntaxHighlightGroovy + const SyntaxHighlightHTML + const SyntaxHighlightHaskell + const SyntaxHighlightJSON + const SyntaxHighlightJava + const SyntaxHighlightJavaScript + const SyntaxHighlightJulia + const SyntaxHighlightKotlin + const SyntaxHighlightLua + const SyntaxHighlightMermaid + const SyntaxHighlightNone + const SyntaxHighlightOCaml + const SyntaxHighlightObjectiveC + const SyntaxHighlightPHP + const SyntaxHighlightPerl + const SyntaxHighlightPython + const SyntaxHighlightR + const SyntaxHighlightRuby + const SyntaxHighlightRust + const SyntaxHighlightSQL + const SyntaxHighlightScala + const SyntaxHighlightScheme + const SyntaxHighlightShell + const SyntaxHighlightSwift + const SyntaxHighlightTeX + const SyntaxHighlightText + const SyntaxHighlightTypeScript + const SyntaxHighlightVBNet + const SyntaxHighlightXML + const SyntaxHighlightYAML + type TableOptions struct + AutoWrapText bool + type TableSet struct + Header []string + Rows [][]string + func (t *TableSet) ValidateColumns() error
Go to main page