Skip to content

Add hashtag to headings #229

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.

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

Merged
merged 3 commits into from
Apr 23, 2025
Merged

Add hashtag to headings #229

merged 3 commits into from
Apr 23, 2025

Conversation

lamATnginx
Copy link
Collaborator

@lamATnginx lamATnginx commented Apr 22, 2025

Proposed changes

Closes https://github.com/nginxinc/docs-platform/issues/433

Video to demonstrate hovering shows # within its bounds + there is a # on the current anchor link:
https://github.com/user-attachments/assets/9f155f24-da60-40f1-b86d-eb5d5609c849

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)

@lamATnginx lamATnginx added the enhancement New feature or request label Apr 22, 2025
@lamATnginx lamATnginx self-assigned this Apr 22, 2025
@lamATnginx lamATnginx requested a review from a team as a code owner April 22, 2025 13:26
Copy link

Playwright visual snapshot differences were detected.

View the Playwright report
To approve the snapshot changes and update the snapshots, please comment: /approve-snapshots

@lamATnginx
Copy link
Collaborator Author

Need suggestions on if the text and not just the # icon should be clickable. Similar to https://zed.dev/docs/#configure-zed

If so, the render-heading file would need to be refactored, potentially affecting old theme.

@nginx-jack
Copy link
Collaborator

nginx-jack commented Apr 22, 2025

@lamATnginx I think we'd want it to be clickable for sure - might need to data-mf="false" / data-mf="true the old and new stuff respectively 🤔 .

@lamATnginx
Copy link
Collaborator Author

lamATnginx commented Apr 22, 2025

Need a design pass but here is the updated video

Screen.Recording.2025-04-22.at.8.37.10.AM.mov

@lamATnginx
Copy link
Collaborator Author

lamATnginx commented Apr 22, 2025

Need a design pass but here is the updated video
Screen.Recording.2025-04-22.at.8.37.10.AM.mov

Heading color has been changed to black + removed hover underline.

Copy link
Collaborator

@nginx-jack nginx-jack left a comment

Choose a reason for hiding this comment

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

LGTM locally, nice one Lam!

@lamATnginx lamATnginx merged commit 762ec01 into main Apr 23, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants