Skip to content

Support Markdown Anchor Links #3

Description

@rLukoyanov

Problem

Markdown documents currently do not support navigation through internal anchor links (e.g. #installation) or links to specific sections within the same README. As a result, users cannot navigate directly to a section, and links in tables of contents or cross-references do not work as expected.

Proposed Solution

Implement support for Markdown anchor links by updating the URL and scrolling to the corresponding section when an anchor link is clicked, similar to GitHub's behavior.

Benefits

  • Enables navigation via table of contents links.
  • Supports deep linking to specific sections within a README.
  • Makes Markdown documentation behave consistently with GitHub.
  • Improves usability for long documentation pages.

Acceptance Criteria

  • Clicking an internal Markdown anchor link updates the URL with the corresponding hash.
  • The page scrolls to the target heading.
  • Opening a URL with a hash (e.g. /README#installation) automatically scrolls to the corresponding section.
  • Existing Markdown rendering behavior remains unchanged.

Expected Behavior

  1. click on md link
Image
  1. page scrolled on linked title
Image

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions