markdown

package

v0.8.13 Latest Latest Go to latest Published: Dec 24, 2019 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/typical-go/typical-rest-server

Links

Open Source Insights

Documentation ¶

Index ¶

type Markdown
- func NewMarkdown(writer io.Writer) *Markdown

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Markdown ¶

type Markdown struct {
	io.Writer
}

Markdown builder

func NewMarkdown ¶

func NewMarkdown(writer io.Writer) *Markdown

NewMarkdown return new instance of Markdown

func (*Markdown) CodeSnippet ¶

func (m *Markdown) CodeSnippet(code string) (int, error)

CodeSnippet to create code snippet

func (*Markdown) Comment ¶

func (m *Markdown) Comment(comment string) (int, error)

Comment for comment

func (*Markdown) H1 ¶

func (m *Markdown) H1(text string) (int, error)

H1 write for heading 1

func (*Markdown) H2 ¶

func (m *Markdown) H2(text string) (int, error)

H2 write for heading 2

func (*Markdown) H3 ¶

func (m *Markdown) H3(text string) (int, error)

H3 write for heading 3

func (*Markdown) H4 ¶

func (m *Markdown) H4(text string) (int, error)

H4 write for heading 4

func (*Markdown) Hr ¶ added in v0.8.8

func (m *Markdown) Hr() (int, error)

Hr to print horizontal rule

func (*Markdown) InlineCode ¶

func (m *Markdown) InlineCode(code string) (int, error)

InlineCode to create inline code

func (*Markdown) OrderedList ¶

func (m *Markdown) OrderedList(list ...string)

OrderedList to create ordered list

func (*Markdown) UnorderedList ¶

func (m *Markdown) UnorderedList(list ...string)

UnorderedList to create unorder list

func (*Markdown) WriteString ¶

func (m *Markdown) WriteString(s string) (int, error)

WriteString to write string

func (*Markdown) Writef ¶

func (m *Markdown) Writef(format string, args ...interface{}) (int, error)

Writef same WriteString with formatting

func (*Markdown) Writeln ¶

func (m *Markdown) Writeln(text string) (int, error)

Writeln write string followed by end line

func (*Markdown) Writelnf ¶

func (m *Markdown) Writelnf(format string, args ...interface{}) (int, error)

Writelnf write formatted string followed by end line

Source Files ¶

View all Source files

markdown.go

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