markup icon indicating copy to clipboard operation
markup copied to clipboard

Request: Allow Controlling Clickability of Headings in README Files

Open danielbrodi opened this issue 2 years ago • 2 comments

I've noticed that headings in README files on GitHub are automatically generating clickable links to anchor points within the README. While this feature can be useful in some cases, it can also lead to unintended behavior when the intention is to have non-clickable headings.

Issue:

Automatic Clickability: Currently, all headings in README files, whether written as <h1>, <h2>, or using Markdown's #, are automatically generating clickable links. This behavior seems to have changed recently, and it results in headings behaving like links by default. For example: ### Technologies will automatically create an anchor point to: https://github.com/daniel#technologies.

Intention for Non-Clickable Headings: In some cases, README authors may prefer to have headings that are not clickable, especially when the intention is not to link to sections within the README. This behavior may be more in line with the intended use of headings for organizational purposes.

Request:

I would like to request an enhancement to GitHub's Markdown rendering behavior to allow authors more control over the clickability of headings in README files:

Optional Clickability: Provide an option or syntax that allows authors to specify whether a heading should be clickable or not. For example, using an attribute or flag in the Markdown syntax.

Consistency: Ensure that the default behavior remains consistent with the intended use of headings for organization and structure, which is typically non-clickable.

Examples of possible solution:

<!-- A potential syntax for specifying non-clickable headings -->
<h1 clickable="false">Welcome to Daniel's GitHub</h1>

[clickable=false]### Technologies

danielbrodi avatar Sep 23 '23 16:09 danielbrodi

I also agree, now my profile looks soo "linky" and the all headings are blue, that's uglyyy, I don't wanna add links for my headings, but its automatically adding links. that's not goooood

ktauchathuranga avatar Sep 24 '23 13:09 ktauchathuranga