Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use anchor link alias for TOC #1298

Merged
merged 3 commits into from
Jun 27, 2022
Merged

use anchor link alias for TOC #1298

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d4ad95
use anchor link alias for TOC
kschoche Jun 21, 2022
929dfb2
add a funcmap and use lowercase for alias names
kschoche Jun 22, 2022
8edbb2d
Update tests
lkysow Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions hack/helm-reference-gen/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,17 @@ var (
// And will not match the "# yaml comment" incorrectly.
commentPrefix = regexp.MustCompile(`(?m)^[^\S\n]*#[^\S\n]?`)

funcMap = template.FuncMap{
"ToLower": strings.ToLower,
}

// docNodeTmpl is the go template used to print a DocNode node.
// We use $ instead of ` in the template so we can use the golang raw string
// format. We then do the replace from $ => `.
docNodeTmpl = template.Must(
template.New("").Parse(
template.New("").Funcs(funcMap).Parse(
strings.Replace(
`{{- if eq .Column 1 }}### {{ .Key }}
`{{- if eq .Column 1 }}### {{ .Key }} ((#h-{{ .Key | ToLower }}))
lkysow marked this conversation as resolved.
Show resolved Hide resolved

{{ end }}{{ .LeadingIndent }}- ${{ .Key }}$ ((#v{{ .HTMLAnchor }})){{ if ne .FormattedKind "" }} (${{ .FormattedKind }}{{ if .FormattedDefault }}: {{ .FormattedDefault }}{{ end }}$){{ end }}{{ if .FormattedDocumentation}} - {{ .FormattedDocumentation }}{{ end }}`,
"$", "`", -1)),
Expand Down Expand Up @@ -407,7 +411,7 @@ func generateTOC(node DocNode) string {
toc := tocPrefix

for _, c := range node.Children {
toc += fmt.Sprintf("- [`%s`](#%s)\n", c.Key, strings.ToLower(c.Key))
toc += fmt.Sprintf("- [`%s`](#h-%s)\n", c.Key, strings.ToLower(c.Key))
}

return toc + tocSuffix
Expand Down