here

Documentation

Overview

Package here provides creation of here-documents from raw strings.

Golang supports raw-string syntax.

doc := `
	Foo
	Bar
`

But raw-string cannot recognize indentation. Thus such content is an indented string, equivalent to

"\n\tFoo\n\tBar\n"

This doesn't look good when incorporating texts into markdown or other formats.

`here` solves this problem by removing unnecessary indentation based on the minimum indentation detected:

doc := here.Doc(`
	Foo
	Bar
`)

Is equivalent to

"Foo\nBar\n"

Given that the backtick in Go cannot be re-used in blocks, `here` will automatically replace all tildes (~) with backticks (`), unless escaped.

"This is a ~code~ example with \~ tildes"

Will be converted to:

"This is a `code` example with ~ tildes"

Index

• func Bytes(raw string) []byte
• func Doc(raw string) string
• func Docf(raw string, args ...interface{}) string

Functions

func Bytes

func Bytes(raw string) []byte

Bytes returns un-indented byte array from the provided here-document.

func Doc

func Doc(raw string) string

Doc returns un-indented string as here-document.

func Docf

func Docf(raw string, args ...interface{}) string

Docf returns unindented and formatted string as here-document. Formatting is done as for fmt.Printf().