1# heredoc [![CircleCI](https://circleci.com/gh/MakeNowJust/heredoc.svg?style=svg)](https://circleci.com/gh/MakeNowJust/heredoc) [![Go Walker](http://gowalker.org/api/v1/badge)](https://gowalker.org/github.com/MakeNowJust/heredoc)
2
3## About
4
5Package heredoc provides the here-document with keeping indent.
6
7## Install
8
9```console
10$ go get github.com/MakeNowJust/heredoc
11```
12
13## Import
14
15```go
16// usual
17import "github.com/MakeNowJust/heredoc"
18// shortcuts
19import . "github.com/MakeNowJust/heredoc/dot"
20```
21
22## Example
23
24```go
25package main
26
27import (
28	"fmt"
29	. "github.com/MakeNowJust/heredoc/dot"
30)
31
32func main() {
33	fmt.Println(D(`
34		Lorem ipsum dolor sit amet, consectetur adipisicing elit,
35		sed do eiusmod tempor incididunt ut labore et dolore magna
36		aliqua. Ut enim ad minim veniam, ...
37	`))
38	// Output:
39	// Lorem ipsum dolor sit amet, consectetur adipisicing elit,
40	// sed do eiusmod tempor incididunt ut labore et dolore magna
41	// aliqua. Ut enim ad minim veniam, ...
42	//
43}
44```
45
46## API Document
47
48 - [Go Walker - github.com/MakeNowJust/heredoc](https://gowalker.org/github.com/MakeNowJust/heredoc)
49 - [Go Walker - github.com/MakeNowJust/heredoc/dot](https://gowalker.org/github.com/MakeNowJust/heredoc/dot)
50
51## License
52
53This software is released under the MIT License, see LICENSE.
54