qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 10:04:43 -07:00
Code Releases Activity

godoc: add on-hover permalink anchors across the site

Browse Source 
We already have anchors for godoc types and functions. Add them for
every heading (and "dl") on every other page on the site.

Change-Id: Ibad77f04442e48dd5a41de759010625f89b48604
Reviewed-on: https://go-review.googlesource.com/33641
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Chris Broadfoot 2016-11-28 15:24:11 -08:00
parent 6c803ab014
commit c97d1a2623
3 changed files with 57 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
godoc/static/godocs.js
View File

@ -305,9 +305,36 @@ function updateVersionTags() {
}
}
function addPermalinks() {
function addPermalink(source, parent) {
var id = source.attr("id");
if (id == "" || id.indexOf("tmp_") === 0) {
// Auto-generated permalink.
return;
}
if (parent.find("> .permalink").length) {
// Already attached.
return;
}
parent.append(" ").append($("<a class='permalink'>&#xb6;</a>").attr("href", "#" + id));
}
$("#page .container").find("h2[id], h3[id]").each(function() {
var el = $(this);
addPermalink(el, el);
});
$("#page .container").find("dl[id]").each(function() {
var el = $(this);
// Add the anchor to the "dt" element.
addPermalink(el, el.find("> dt").first());
});
}
$(document).ready(function() {
bindSearchEvents();
generateTOC();
addPermalinks();
bindToggles(".toggle");
bindToggles(".toggleVisible");
bindToggleLinks(".exampleLink", "example_");

31
godoc/static/static.go
View File

@ -875,9 +875,36 @@ function updateVersionTags() {
}
}
function addPermalinks() {
function addPermalink(source, parent) {
var id = source.attr("id");
if (id.indexOf("tmp_") === 0) {
// Auto-generated permalink.
return;
}
if (parent.find("> .permalink").length) {
// Already attached.
return;
}
parent.append(" ").append($("&nbsp;<a class='permalink'>&#xb6;</a>").attr("href", "#" + id));
}
$("#page .container").find("h2[id], h3[id]").each(function() {
var el = $(this);
addPermalink(el, el);
});
$("#page .container").find("dl[id]").each(function() {
var el = $(this);
// Add the anchor to the "dt" element.
addPermalink(el, el.find("> dt").first());
});
}
$(document).ready(function() {
bindSearchEvents();
generateTOC();
addPermalinks();
bindToggles(".toggle");
bindToggles(".toggleVisible");
bindToggleLinks(".exampleLink", "example_");
@ -1599,8 +1626,8 @@ function cgAddChild(tree, ul, cgn) {
</script>
{{if $.IsMain}}
{{comment_html .Doc}}
{{/* command documentation */}}
{{comment_html .Doc}}
{{else}}
{{/* package documentation */}}
<div id="short-nav">
@ -2849,7 +2876,7 @@ a:hover,
.permalink {
display: none;
}
h2:hover .permalink, h3:hover .permalink {
:hover > .permalink {
display: inline;
}

2
godoc/static/style.css
View File

@ -46,7 +46,7 @@ a:hover,
.permalink {
display: none;
}
h2:hover .permalink, h3:hover .permalink {
:hover > .permalink {
display: inline;
}