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

Blog post generated section "On this page" #14

Closed
EthanThatOneKid opened this issue Nov 13, 2024 · 0 comments · Fixed by #16
Closed

Blog post generated section "On this page" #14

EthanThatOneKid opened this issue Nov 13, 2024 · 0 comments · Fixed by #16
Labels
enhancement New feature or request

Comments

@EthanThatOneKid
Copy link
Contributor

EthanThatOneKid commented Nov 13, 2024

This proposal suggests adding a table of contents (TOC) section near the top of blog posts. This would enhance the user experience by giving visitors a quick overview of the page's content structure and allowing them to jump directly to relevant headings.

Benefits

  • Improved Navigation: Users can easily scan the TOC to understand the post's layout and jump to specific sections.
  • Enhanced Readability: A well-structured TOC provides a visual guide, making the content easier to follow.
  • Increased Accessibility: Users with assistive technologies can leverage the TOC for navigation.

Features

  • toc?: boolean defaults to true, but can be set to false in the blog post's front-matter.

Prior art

Several open-source Markdown-it plugins can generate TOCs, including:

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 a pull request may close this issue.

1 participant