This markdown was generated with the help of custom template file (example.template). To add custom markdown to your documentation, you can do something like:
godocdown -template=godocdown.tmpl ...
The template format is the standard Go text/template: http://golang.org/pkg/text/template
Along with the standard template functionality, the starting data argument has the following interface:
{{ .Emit }}
// Emit the standard documentation (what godocdown would emit without a template)
{{ .EmitHeader }}
// Emit the package name and an import line (if one is present/needed)
{{ .EmitSynopsis }}
// Emit the package declaration
{{ .EmitUsage }}
// Emit package usage, which includes a constants section, a variables section,
// a functions section, and a types section. In addition, each type may have its own constant,
// variable, and/or function/method listing.
{{ if .IsCommand }} ... {{ end }}
// A boolean indicating whether the given package is a command or a plain package
{{ .Name }}
// The name of the package/command (string)
{{ .ImportPath }}
// The import path for the package (string)
// (This field will be the empty string if godocdown is unable to guess it)
godocdown for the http://golang.org/pkg/strings package:
--
-- import "strings"
Package strings implements simple functions to manipulate strings.
func Contains(s, substr string) boolContains returns true if substr is within s.
func ContainsAny(s, chars string) boolContainsAny returns true if any Unicode code points in chars are within s.
func ContainsRune(s string, r rune) boolContainsRune returns true if the Unicode code point r is within s.
func Count(s, sep string) intCount counts the number of non-overlapping instances of sep in s.
func EqualFold(s, t string) boolEqualFold reports whether s and t, interpreted as UTF-8 strings, are equal under Unicode case-folding.
func Fields(s string) []stringFields splits the string s around each instance of one or more consecutive white space characters, as defined by unicode.IsSpace, returning an array of substrings of s or an empty list if s contains only white space.
func FieldsFunc(s string, f func(rune) bool) []stringFieldsFunc splits the string s at each run of Unicode code points c satisfying f(c) and returns an array of slices of s. If all code points in s satisfy f(c) or the string is empty, an empty slice is returned.
func HasPrefix(s, prefix string) boolHasPrefix tests whether the string s begins with prefix.
func HasSuffix(s, suffix string) boolHasSuffix tests whether the string s ends with suffix.
func Index(s, sep string) intIndex returns the index of the first instance of sep in s, or -1 if sep is not present in s.
func IndexAny(s, chars string) intIndexAny returns the index of the first instance of any Unicode code point from chars in s, or -1 if no Unicode code point from chars is present in s.
func IndexFunc(s string, f func(rune) bool) intIndexFunc returns the index into s of the first Unicode code point satisfying f(c), or -1 if none do.
func IndexRune(s string, r rune) intIndexRune returns the index of the first instance of the Unicode code point r, or -1 if rune is not present in s.
func Join(a []string, sep string) stringJoin concatenates the elements of a to create a single string. The separator string sep is placed between elements in the resulting string.
func LastIndex(s, sep string) intLastIndex returns the index of the last instance of sep in s, or -1 if sep is not present in s.
func LastIndexAny(s, chars string) intLastIndexAny returns the index of the last instance of any Unicode code point from chars in s, or -1 if no Unicode code point from chars is present in s.
func LastIndexFunc(s string, f func(rune) bool) intLastIndexFunc returns the index into s of the last Unicode code point satisfying f(c), or -1 if none do.
func Map(mapping func(rune) rune, s string) stringMap returns a copy of the string s with all its characters modified according to the mapping function. If mapping returns a negative value, the character is dropped from the string with no replacement.
func Repeat(s string, count int) stringRepeat returns a new string consisting of count copies of the string s.
func Replace(s, old, new string, n int) stringReplace returns a copy of the string s with the first n non-overlapping instances of old replaced by new. If n < 0, there is no limit on the number of replacements.
func Split(s, sep string) []stringSplit slices s into all substrings separated by sep and returns a slice of the substrings between those separators. If sep is empty, Split splits after each UTF-8 sequence. It is equivalent to SplitN with a count of -1.
func SplitAfter(s, sep string) []stringSplitAfter slices s into all substrings after each instance of sep and returns a slice of those substrings. If sep is empty, SplitAfter splits after each UTF-8 sequence. It is equivalent to SplitAfterN with a count of -1.
func SplitAfterN(s, sep string, n int) []stringSplitAfterN slices s into substrings after each instance of sep and returns a slice of those substrings. If sep is empty, SplitAfterN splits after each UTF-8 sequence. The count determines the number of substrings to return:
n > 0: at most n substrings; the last substring will be the unsplit remainder.
n == 0: the result is nil (zero substrings)
n < 0: all substrings
func SplitN(s, sep string, n int) []stringSplitN slices s into substrings separated by sep and returns a slice of the substrings between those separators. If sep is empty, SplitN splits after each UTF-8 sequence. The count determines the number of substrings to return:
n > 0: at most n substrings; the last substring will be the unsplit remainder.
n == 0: the result is nil (zero substrings)
n < 0: all substrings
func Title(s string) stringTitle returns a copy of the string s with all Unicode letters that begin words mapped to their title case.
BUG: The rule Title uses for word boundaries does not handle Unicode punctuation properly.
func ToLower(s string) stringToLower returns a copy of the string s with all Unicode letters mapped to their lower case.
func ToLowerSpecial(_case unicode.SpecialCase, s string) stringToLowerSpecial returns a copy of the string s with all Unicode letters mapped to their lower case, giving priority to the special casing rules.
func ToTitle(s string) stringToTitle returns a copy of the string s with all Unicode letters mapped to their title case.
func ToTitleSpecial(_case unicode.SpecialCase, s string) stringToTitleSpecial returns a copy of the string s with all Unicode letters mapped to their title case, giving priority to the special casing rules.
func ToUpper(s string) stringToUpper returns a copy of the string s with all Unicode letters mapped to their upper case.
func ToUpperSpecial(_case unicode.SpecialCase, s string) stringToUpperSpecial returns a copy of the string s with all Unicode letters mapped to their upper case, giving priority to the special casing rules.
func Trim(s string, cutset string) stringTrim returns a slice of the string s with all leading and trailing Unicode code points contained in cutset removed.
func TrimFunc(s string, f func(rune) bool) stringTrimFunc returns a slice of the string s with all leading and trailing Unicode code points c satisfying f(c) removed.
func TrimLeft(s string, cutset string) stringTrimLeft returns a slice of the string s with all leading Unicode code points contained in cutset removed.
func TrimLeftFunc(s string, f func(rune) bool) stringTrimLeftFunc returns a slice of the string s with all leading Unicode code points c satisfying f(c) removed.
func TrimPrefix(s, prefix string) stringTrimPrefix returns s without the provided leading prefix string. If s doesn't start with prefix, s is returned unchanged.
func TrimRight(s string, cutset string) stringTrimRight returns a slice of the string s, with all trailing Unicode code points contained in cutset removed.
func TrimRightFunc(s string, f func(rune) bool) stringTrimRightFunc returns a slice of the string s with all trailing Unicode code points c satisfying f(c) removed.
func TrimSpace(s string) stringTrimSpace returns a slice of the string s, with all leading and trailing white space removed, as defined by Unicode.
func TrimSuffix(s, suffix string) stringTrimSuffix returns s without the provided trailing suffix string. If s doesn't end with suffix, s is returned unchanged.
type Reader struct {
}A Reader implements the io.Reader, io.ReaderAt, io.Seeker, io.WriterTo, io.ByteScanner, and io.RuneScanner interfaces by reading from a string.
func NewReader(s string) *ReaderNewReader returns a new Reader reading from s. It is similar to bytes.NewBufferString but more efficient and read-only.
func (r *Reader) Len() intLen returns the number of bytes of the unread portion of the string.
func (r *Reader) Read(b []byte) (n int, err error)func (r *Reader) ReadAt(b []byte, off int64) (n int, err error)func (r *Reader) ReadByte() (b byte, err error)func (r *Reader) ReadRune() (ch rune, size int, err error)func (r *Reader) Seek(offset int64, whence int) (int64, error)Seek implements the io.Seeker interface.
func (r *Reader) UnreadByte() errorfunc (r *Reader) UnreadRune() errorfunc (r *Reader) WriteTo(w io.Writer) (n int64, err error)WriteTo implements the io.WriterTo interface.
type Replacer struct {
}A Replacer replaces a list of strings with replacements.
func NewReplacer(oldnew ...string) *ReplacerNewReplacer returns a new Replacer from a list of old, new string pairs. Replacements are performed in order, without overlapping matches.
func (r *Replacer) Replace(s string) stringReplace returns a copy of s with all replacements performed.
func (r *Replacer) WriteString(w io.Writer, s string) (n int, err error)WriteString writes s to w with all replacements performed.