Skip to content

feat: generate dynamic docs header links #2055

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

Open
wants to merge 12 commits into
base: gh-pages
Choose a base branch
from
Open

feat: generate dynamic docs header links #2055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0006a2e
add header links
ShubhamOulkar Sep 9, 2025
d6bbad9
fix redeclaration
ShubhamOulkar Sep 9, 2025
7a564ea
fix design
ShubhamOulkar Sep 9, 2025
8fd9b24
add margin and font size
ShubhamOulkar Sep 9, 2025
9317fd8
change link content to hash
ShubhamOulkar Sep 14, 2025
77deb08
remove outline and add color to hash
ShubhamOulkar Sep 14, 2025
65b920f
Merge branch 'gh-pages' into generate-header-links
ShubhamOulkar Sep 14, 2025
5ebee47
correct aria-label value
ShubhamOulkar Sep 20, 2025
7498eb3
Scope header selection to main section
ShubhamOulkar Sep 24, 2025
3e31697
add target highliting to header links
ShubhamOulkar Sep 24, 2025
4e8a859
inherit color and font size from parent headers
ShubhamOulkar Sep 24, 2025
2d3f972
expand link clickable area
ShubhamOulkar Sep 24, 2025
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
22 changes: 22 additions & 0 deletions css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1116,6 +1116,27 @@ h2 a {
font-size: 16px;
}

/* h2 -> h3 header links */
.heading-link::after {
content: '#';
}

.heading-link {
padding-inline: 0.3em;
font-size: inherit;
text-decoration: none;
color: inherit;
opacity: 0;
transition: opacity 0.2s ease-in-out;
}

h2:hover .heading-link,
h3:hover .heading-link,
:target .heading-link,
.heading-link:is(:hover, :focus, :focus-visible) {
opacity: 1;
}

/* search-bar desktop re-sizing */
@media all and (min-width: 950px) {
.algolia-autocomplete {
Expand Down Expand Up @@ -1736,3 +1757,4 @@ blockquote {
border-bottom: 1px solid var(--border);
}
}

11 changes: 11 additions & 0 deletions js/copycode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const codeBlocks = document.querySelectorAll("pre:has(code)");
const headers = document.querySelectorAll('main :is(h2,h3)[id]');

codeBlocks.forEach((block) => {
// Only add button if browser supports Clipboard API
Expand All @@ -13,6 +14,15 @@ codeBlocks.forEach((block) => {
});
});

// add heading links
for (const heading of headers) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
for (const heading of headers) {
for (const heading of headers) {
if (h.querySelector('.heading-link')) continue;

Nit: A little paranoid but this will guard against the script running twice somehow by accident or hot reloading or something, preventing us from adding the elements twice.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want thinking of implementing lazy attach links using IntersectionObserver or MutationObserver. WDYT?

Is there a reason why this is living inside the copycode.js script file?

Copy code and header link share same logic and needs asynchronous implementation.

const linkIcon = document.createElement('a');
linkIcon.setAttribute('href', `#${heading.id}`);
linkIcon.classList.add('heading-link');
linkIcon.setAttribute("aria-label", `to section ${heading.textContent.trim()}`);
heading.appendChild(linkIcon);
}

function createCopyButton() {
const button = document.createElement("button");
setButtonAttributes(button, {
Expand Down Expand Up @@ -57,3 +67,4 @@ function updateButtonState(button, statusClass, ariaLabel) {

button.dataset.timerId = timer;
}