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.

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

[2.x] Semantic Tailwind Markdown heading permalinks #2052

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented Dec 4, 2024

Advantages:

  • Cleaner semantics: The id directly ties to the heading itself, which aligns well with HTML5 standards.
  • Improved accessibility: Assistive technologies can better associate the id with the heading content.
  • CSS styling: Easier to target headings via their id for custom styles.

See #2047 (comment)

Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3d3ed48) to head (9c49d46).
Report is 11 commits behind head on custom-markdown-heading-renderer.

Additional details and impacted files
@@                         Coverage Diff                          @@
##             custom-markdown-heading-renderer     #2052   +/-   ##
====================================================================
  Coverage                              100.00%   100.00%           
  Complexity                               1928      1928           
====================================================================
  Files                                     196       196           
  Lines                                    5125      5125           
====================================================================
  Hits                                     5125      5125           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caendesilva caendesilva force-pushed the semantic-markdown-heading-permalinks branch from 24af854 to e7be152 Compare December 4, 2024 08:41
@caendesilva caendesilva changed the title [2.x] Semantic markdown heading permalinks [2.x] Semantic Markdown heading permalinks Dec 4, 2024
@caendesilva caendesilva force-pushed the semantic-markdown-heading-permalinks branch from 1310621 to af9f4fa Compare December 5, 2024 09:40
@caendesilva caendesilva changed the title [2.x] Semantic Markdown heading permalinks [2.x] Semantic Tailwind Markdown heading permalinks Dec 5, 2024
@caendesilva caendesilva merged commit 7ebd17f into custom-markdown-heading-renderer Dec 5, 2024
8 checks passed
@caendesilva caendesilva deleted the semantic-markdown-heading-permalinks branch December 5, 2024 09:55
@caendesilva caendesilva mentioned this pull request Dec 8, 2024
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant