Skip to content

Feature: Implement Heading Permalinks with Hover/Visible Chain Icon #596

New issue
New issue
Closed
#606
Closed
Feature: Implement Heading Permalinks with Hover/Visible Chain Icon#596
#606
Assignees
HIMU-2001
Labels
framework/hugohelp wantedExtra attention is neededkind/enhancementImprovement in current featurelanguage/csslanguage/htmllanguage/javascriptJavascript related
@zihanKuang

Description

@zihanKuang
zihanKuang
opened on Jun 5, 2025
Contributor

Introduce a feature that allows users to easily obtain and share direct hyperlinks (anchor links) for each heading (e.g., H1, H2, H3, H4) in Layer5 Docs. This should be visually indicated by a chain icon (🔗) associated with each heading, which could either appear on mouse hover or be always visible.

The functionality on GitHub Docs serves as a good example: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal[…]/managing-user-account-settings/changing-your-github-username

Image

Activity

zihanKuang
added
help wantedExtra attention is needed
kind/enhancementImprovement in current feature
language/javascriptJavascript related
language/css
language/html
framework/hugo
on Jun 5, 2025
FavourTy

FavourTy commented on Jun 5, 2025

@FavourTy
FavourTy
on Jun 5, 2025

Hi @zihanKuang I would like to work on this issue

zihanKuang
assigned
FavourTy
on Jun 5, 2025
HIMU-2001

HIMU-2001 commented on Jun 12, 2025

@HIMU-2001
HIMU-2001
on Jun 12, 2025
Contributor

Hi @zihanKuang ,

I'd love to take this up! Just wanted to confirm a couple of things before I proceed:

  1. Should the permalink icon (🔗) appear only on hover, or do we want it to always be visible?
  2. Do we have any existing styling or behavior guidelines for the icon placement and animation (e.g., fade in/out on hover)?
  3. Should it support all headings (h1 through h4) across all content pages, or only within the main documentation content?

Please assign this to me if everything looks good. I'd be happy to help implement this!

Thanks!

zihanKuang

zihanKuang commented on Jun 16, 2025

@zihanKuang
zihanKuang
on Jun 16, 2025
ContributorAuthor

@HIMU-2001 ,Thanks! When you're implementing this, please pay attention to the issues mentioned here: #597 😎

zihanKuang
assigned
HIMU-2001
and unassigned
FavourTy
on Jun 16, 2025
HIMU-2001
mentioned this on Jun 16, 2025
HIMU-2001

HIMU-2001 commented on Jun 16, 2025

@HIMU-2001
HIMU-2001
on Jun 16, 2025
Contributor

Hi @zihanKuang ,

Could you please take a look at the PR : 606

Thank You.

zihanKuang
closed this as completedin #606on Jun 16, 2025
zihanKuang
added a commit that references this issue on Jun 16, 2025

Merge pull request #606 from HIMU-2001/heading-permalinks

984a607
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

framework/hugohelp wantedExtra attention is neededkind/enhancementImprovement in current featurelanguage/csslanguage/htmllanguage/javascriptJavascript related

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @HIMU-2001@FavourTy@zihanKuang

    Issue actions
      Feature: Implement Heading Permalinks with Hover/Visible Chain Icon · Issue #596 · layer5io/docs