md

package

v0.2.1 Latest Latest Go to latest Published: Jul 12, 2019 License: MIT Imports: 11 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/BakerHub/trivial

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Code(txt string) string
func Em(txt string) string
func Escape(txt string) string
func Image(caption string, urlAndTitle ...string) string
func Link(txt string, urlAndTitle ...string) string
func Strong(txt string) string
type List
- func (l *List) NextBullet() string
type Option
- func Indent(indent string) Option
- func LineLength(limit int) Option
type Writer
- func NewWriter(writer io.Writer, options ...Option) *Writer

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrInvalidHeadingLevel = errors.New("head level should between [1..6]")

Functions ¶

func Code ¶ added in v0.2.0

func Code(txt string) string

Code spans, wraps the input string with backtick (`).

func Em ¶ added in v0.2.0

func Em(txt string) string

Em emphasis by wrap text with * or _.

func Escape ¶ added in v0.2.0

func Escape(txt string) string

Escape string start with ASCII punctuation character using backslash (\). Strings not start with ASCII punctuation character are returned without escape.

func Image ¶ added in v0.2.0

func Image(caption string, urlAndTitle ...string) string

Link generates image with caption and optional url and title.

func Link ¶ added in v0.2.0

func Link(txt string, urlAndTitle ...string) string

Link generates link with text and optional url and title.

func Strong ¶ added in v0.2.0

func Strong(txt string) string

Strong emphasis by wrap text with ** or __.

Types ¶

type List ¶

type List struct {
	// contains filtered or unexported fields
}

func (*List) NextBullet ¶

func (l *List) NextBullet() string

type Option ¶

type Option func(*Writer)

func Indent ¶

func Indent(indent string) Option

func LineLength ¶

func LineLength(limit int) Option

type Writer ¶

type Writer struct {
	// contains filtered or unexported fields
}

func NewWriter ¶

func NewWriter(writer io.Writer, options ...Option) *Writer

func (*Writer) BeginOrderedList ¶

func (wr *Writer) BeginOrderedList()

func (*Writer) BeginUnorderedList ¶

func (wr *Writer) BeginUnorderedList()

func (*Writer) EndList ¶

func (wr *Writer) EndList()

func (*Writer) WriteFencedCodeBlock ¶

func (wr *Writer) WriteFencedCodeBlock(code string, language string)

func (*Writer) WriteH1 ¶

func (wr *Writer) WriteH1(text string)

func (*Writer) WriteH2 ¶

func (wr *Writer) WriteH2(text string)

func (*Writer) WriteH3 ¶

func (wr *Writer) WriteH3(text string)

func (*Writer) WriteH4 ¶

func (wr *Writer) WriteH4(text string)

func (*Writer) WriteH5 ¶

func (wr *Writer) WriteH5(text string)

func (*Writer) WriteH6 ¶

func (wr *Writer) WriteH6(text string)

func (*Writer) WriteHorizontalRule ¶

func (wr *Writer) WriteHorizontalRule()

func (*Writer) WriteIndentedCodeBlock ¶

func (wr *Writer) WriteIndentedCodeBlock(code string)

func (*Writer) WriteListItem ¶

func (wr *Writer) WriteListItem(text string)

func (*Writer) WriteParagraph ¶

func (wr *Writer) WriteParagraph(txt string)

Source Files ¶

View all Source files

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