Skip to content
This repository was archived by the owner on Jul 29, 2021. It is now read-only.

Commit deb306d

Browse files
authored
Merge pull request #17 from kenjones-cisco/bugfix/revert-template
Bugfix: Revert previous changes to template
2 parents 2180bc4 + 86145ae commit deb306d

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

template.go

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,76 +6,76 @@ var pkgTemplate = `{{with .PDoc}}
66
{{comment_md .Doc}}
77
{{else}}
88
# {{ .Name }}
9+
` + "`" + `import "{{.ImportPath}}"` + "`" + `
910
10-
* [Overview](#markdown-header-overview)
11-
* [Index](#markdown-header-index){{if $.Examples}}
12-
* [Examples](#markdown-header-examples){{- end}}{{if $.Dirs}}
13-
* [Subdirectories](#markdown-header-subdirectories){{- end}}
11+
* [Overview](#pkg-overview)
12+
* [Index](#pkg-index){{if $.Examples}}
13+
* [Examples](#pkg-examples){{- end}}{{if $.Dirs}}
14+
* [Subdirectories](#pkg-subdirectories){{- end}}
1415
15-
## Overview
16+
## <a name="pkg-overview">Overview</a>
1617
{{comment_md .Doc}}
1718
{{example_html $ ""}}
18-
{{example_text $ "" " "}}
1919
20-
## Index{{if .Consts}}
21-
* [Constants](#markdown-header-constants){{end}}{{if .Vars}}
22-
* [Variables](#markdown-header-variables){{end}}{{- range .Funcs -}}{{$name_html := html .Name}}
23-
* [{{node_html $ .Decl false | sanitize | bitscape}}](#markdown-header-{{node_html $ .Decl false | sanitize | kebab}}){{- end}}{{- range .Types}}{{$tname_html := html .Name}}
24-
* [type {{$tname_html}}](#markdown-header-type-{{kebab $tname_html}}){{- range .Funcs}}{{$name_html := html .Name}}
25-
* [{{node_html $ .Decl false | sanitize | bitscape}}](#markdown-header-func-{{$name_html | kebab}}){{- end}}{{- range .Methods}}{{$name_html := html .Name}}
26-
* [{{node_html $ .Decl false | sanitize | bitscape}}](#markdown-header-func-{{md .Recv | kebab}}-{{$name_html | kebab}}){{- end}}{{- end}}{{- if $.Notes}}{{- range $marker, $item := $.Notes}}
27-
* [{{noteTitle $marker | html}}s](#markdown-header-{{noteTitle $marker | html | kebab}}s}}){{end}}{{end}}
20+
## <a name="pkg-index">Index</a>{{if .Consts}}
21+
* [Constants](#pkg-constants){{end}}{{if .Vars}}
22+
* [Variables](#pkg-variables){{end}}{{- range .Funcs -}}{{$name_html := html .Name}}
23+
* [{{node_html $ .Decl false | sanitize}}](#{{$name_html}}){{- end}}{{- range .Types}}{{$tname_html := html .Name}}
24+
* [type {{$tname_html}}](#{{$tname_html}}){{- range .Funcs}}{{$name_html := html .Name}}
25+
* [{{node_html $ .Decl false | sanitize}}](#{{$name_html}}){{- end}}{{- range .Methods}}{{$name_html := html .Name}}
26+
* [{{node_html $ .Decl false | sanitize}}](#{{$tname_html}}.{{$name_html}}){{- end}}{{- end}}{{- if $.Notes}}{{- range $marker, $item := $.Notes}}
27+
* [{{noteTitle $marker | html}}s](#pkg-note-{{$marker}}){{end}}{{end}}
2828
{{if $.Examples}}
29-
#### Examples{{- range $.Examples}}
30-
* [{{example_name .Name}}]{{- end}}{{- end}}
29+
#### <a name="pkg-examples">Examples</a>{{- range $.Examples}}
30+
* [{{example_name .Name}}](#example_{{.Name}}){{- end}}{{- end}}
3131
{{with .Filenames}}
32-
#### Package files
33-
{{range .}}[{{.|filename|html}}]{{end}}
32+
#### <a name="pkg-files">Package files</a>
33+
{{range .}}[{{.|filename|html}}]({{.|srcLink|html}}) {{end}}
3434
{{end}}
3535
36-
{{with .Consts}}## Constants
36+
{{with .Consts}}## <a name="pkg-constants">Constants</a>
3737
{{range .}}{{node $ .Decl | pre}}
3838
{{comment_md .Doc}}{{end}}{{end}}
39-
{{with .Vars}}## Variables
39+
{{with .Vars}}## <a name="pkg-variables">Variables</a>
4040
{{range .}}{{node $ .Decl | pre}}
4141
{{comment_md .Doc}}{{end}}{{end}}
4242
43-
{{range .Funcs}}{{$name_html := html .Name}}## func [{{$name_html}}]
43+
{{range .Funcs}}{{$name_html := html .Name}}## <a name="{{$name_html}}">func</a> [{{$name_html}}]({{posLink_url $ .Decl}})
4444
{{node $ .Decl | pre}}
4545
{{comment_md .Doc}}
46-
{{example_text $ .Name " "}}
46+
{{example_html $ .Name}}
4747
{{callgraph_html $ "" .Name}}{{end}}
48-
{{range .Types}}{{$tname := .Name}}{{$tname_html := html .Name}}## type [{{$tname_html}}]
48+
{{range .Types}}{{$tname := .Name}}{{$tname_html := html .Name}}## <a name="{{$tname_html}}">type</a> [{{$tname_html}}]({{posLink_url $ .Decl}})
4949
{{node $ .Decl | pre}}
5050
{{comment_md .Doc}}{{range .Consts}}
5151
{{node $ .Decl | pre }}
5252
{{comment_md .Doc}}{{end}}{{range .Vars}}
5353
{{node $ .Decl | pre }}
5454
{{comment_md .Doc}}{{end}}
5555
56-
{{example_text $ $tname " "}}
56+
{{example_html $ $tname}}
5757
{{implements_html $ $tname}}
5858
{{methodset_html $ $tname}}
5959
60-
{{range .Funcs}}{{$name_html := html .Name}}### func [{{$name_html}}]
60+
{{range .Funcs}}{{$name_html := html .Name}}### <a name="{{$name_html}}">func</a> [{{$name_html}}]({{posLink_url $ .Decl}})
6161
{{node $ .Decl | pre}}
6262
{{comment_md .Doc}}
63-
{{example_text $ .Name " "}}{{end}}
63+
{{example_html $ .Name}}{{end}}
6464
{{callgraph_html $ "" .Name}}
6565
66-
{{range .Methods}}{{$name_html := html .Name}}### func ({{md .Recv}}) [{{$name_html}}]
66+
{{range .Methods}}{{$name_html := html .Name}}### <a name="{{$tname_html}}.{{$name_html}}">func</a> ({{md .Recv}}) [{{$name_html}}]({{posLink_url $ .Decl}})
6767
{{node $ .Decl | pre}}
6868
{{comment_md .Doc}}
69-
{{$name := printf "%s_%s" $tname .Name}}{{example_text $ $name " "}}
69+
{{$name := printf "%s_%s" $tname .Name}}{{example_html $ $name}}
7070
{{callgraph_html $ .Recv .Name}}
7171
{{end}}{{end}}{{end}}
7272
7373
{{with $.Notes}}
7474
{{range $marker, $content := .}}
75-
## {{noteTitle $marker | html}}s
75+
## <a name="pkg-note-{{$marker}}">{{noteTitle $marker | html}}s
7676
<ul style="list-style: none; padding: 0;">
7777
{{range .}}
78-
<li>&#x261e; {{html .Body}}</li>
78+
<li><a href="{{posLink_url $ .}}">&#x261e;</a> {{html .Body}}</li>
7979
{{end}}
8080
</ul>
8181
{{end}}

0 commit comments

Comments
 (0)