Merge pull request #8 from lordnynex/patch-1

Update Template

Author: davecheney

template.go

@@ -1,52 +1,78 @@
 package main
 
-var pkgTemplate = `{{with .PDoc}}{{if $.IsMain}}
-# {{ base .ImportPath }}
-
+var pkgTemplate = `{{with .PDoc}}
+{{if $.IsMain}}
+> {{ base .ImportPath }}
 {{comment_md .Doc}}
 {{else}}
 # {{ .Name }}
-    import "{{.ImportPath}}"
+` + "`" + `import "{{.ImportPath}}"` + "`" + `
+
+* [Overview](#pkg-overview)
+* [Index](#pkg-index){{if $.Examples}}
+* [Examples](#pkg-examples){{- end}}{{if $.Dirs}}
+* [Subdirectories](#pkg-subdirectories){{- end}}
 
+## <a name="pkg-overview">Overview</a>
 {{comment_md .Doc}}
 {{example_html $ ""}}
 
-{{with .Consts}}## Constants
-{{range .}}{{node $ .Decl | pre}}
+## <a name="pkg-index">Index</a>
+{{- if .Consts}}* [Constants](#pkg-constants){{end}}
+{{- if .Vars}}* [Variables](#pkg-variables){{end}}{{- range .Funcs -}}{{$name_html := html .Name}}
+* [{{node_html $ .Decl false | sanitize}}](#{{$name_html}}){{- end}}{{- range .Types}}{{$tname_html := html .Name}}
+* [type {{$tname_html}}](#{{$tname_html}}){{- range .Funcs}}{{$name_html := html .Name}}
+  * [{{node_html $ .Decl false | sanitize}}](#{{$name_html}}){{- end}}{{- range .Methods}}{{$name_html := html .Name}}
+  * [{{node_html $ .Decl false | sanitize}}](#{{$tname_html}}.{{$name_html}}){{- end}}{{- end}}{{- if $.Notes}}{{- range $marker, $item := $.Notes}}
+* [{{noteTitle $marker | html}}s](#pkg-note-{{$marker}}){{end}}{{end}}
+{{if $.Examples}}
+#### <a name="pkg-examples">Examples</a>{{- range $.Examples}}
+* [{{example_name .Name}}](#example_{{.Name}}){{- end}}{{- end}}
+{{with .Filenames}}
+#### <a name="pkg-files">Package files</a>
+{{range .}}[{{.|filename|html}}]({{.|srcLink|html}}) {{end}}
+{{end}}
+
+{{with .Consts}}## <a name="pkg-constants">Constants</a>
+{{range .}}{{node $ .Decl true | pre}}
 {{comment_md .Doc}}{{end}}{{end}}
-{{with .Vars}}## Variables
+{{with .Vars}}## <a name="pkg-variables">Variables</a>
 {{range .}}{{node $ .Decl | pre}}
 {{comment_md .Doc}}{{end}}{{end}}
-{{range .Funcs}}{{$name_html := html .Name}}## func {{$name_html}}
+
+{{range .Funcs}}{{$name_html := html .Name}}## <a name="{{$name_html}}">func</a> [{{$name_html}}]({{posLink_url $ .Decl}})
 {{node $ .Decl | pre}}
 {{comment_md .Doc}}
-{{example_html $ .Name}}{{end}}
-{{range .Types}}{{$tname := .Name}}{{$tname_html := html .Name}}## type {{$tname_html}}
+{{example_html $ .Name}}
+{{callgraph_html $ "" .Name}}{{end}}
+{{range .Types}}{{$tname := .Name}}{{$tname_html := html .Name}}## <a name="{{$tname_html}}">type</a> [{{$tname_html}}]({{posLink_url $ .Decl}})
 {{node $ .Decl | pre}}
-{{comment_md .Doc}}
-
-{{range .Consts}}{{node $ .Decl | pre }}
-{{comment_md .Doc}}{{end}}
-
-{{range .Vars}}{{node $ .Decl | pre }}
+{{comment_md .Doc}}{{range .Consts}}
+{{node $ .Decl | pre }}
+{{comment_md .Doc}}{{end}}{{range .Vars}}
+{{node $ .Decl | pre }}
 {{comment_md .Doc}}{{end}}
 
 {{example_html $ $tname}}
+{{implements_html $ $tname}}
+{{methodset_html $ $tname}}
 
-{{range .Funcs}}{{$name_html := html .Name}}### func {{$name_html}}
+{{range .Funcs}}{{$name_html := html .Name}}### <a name="{{$name_html}}">func</a> [{{$name_html}}]({{posLink_url $ .Decl}})
 {{node $ .Decl | pre}}
 {{comment_md .Doc}}
 {{example_html $ .Name}}{{end}}
+{{callgraph_html $ "" .Name}}
 
-{{range .Methods}}{{$name_html := html .Name}}### func ({{md .Recv}}) {{$name_html}}
+{{range .Methods}}{{$name_html := html .Name}}### <a name="{{$tname_html}}.{{$name_html}}">func</a> ({{md .Recv}}) [{{$name_html}}]({{posLink_url $ .Decl}})
 {{node $ .Decl | pre}}
 {{comment_md .Doc}}
 {{$name := printf "%s_%s" $tname .Name}}{{example_html $ $name}}
+{{callgraph_html $ .Recv .Name}}
 {{end}}{{end}}{{end}}
 
 {{with $.Notes}}
 {{range $marker, $content := .}}
-## {{noteTitle $marker | html}}s
+## <a name="pkg-note-{{$marker}}">{{noteTitle $marker | html}}s
 <ul style="list-style: none; padding: 0;">
 {{range .}}
 <li><a href="{{posLink_url $ .}}">&#x261e;</a> {{html .Body}}</li>
@@ -55,7 +81,5 @@ var pkgTemplate = `{{with .PDoc}}{{if $.IsMain}}
 {{end}}
 {{end}}
 {{end}}
-
-{{with .PAst}}{{node_html $ . false}}{{end}}
 - - -
 Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)`