Skip to content

Add rel=edit attribute to "Edit this page on GitHub" link #4749

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

capjamesg
Copy link

Description

This PR adds the rel="edit" attribute to the "Edit this page on GitHub" edit link.

rel=edit lets a page indicate that the linked resource can be used to edit the page. It is defined at https://microformats.org/wiki/rel-edit. This can then be parsed by tools like the Universal Edit Button and custom bookmarklets to open the edit page corresponding with a website.

Linked Issues

N/A

Additional Context

N/A


Tip

The author of this PR can publish a preview release by commenting /publish below.

@brc-dd
Copy link
Member

brc-dd commented May 15, 2025

It should be rel not :rel. But not sure whether we should add this. WHATWG has rejected this. It is not a well defined rel value. And that extension only has 24 downloads. It is some 15 year old obsolete extension that most likely doesn't even work in latest browsers. Also that wiki article is written by you and you just created the PRs to add this in like 10 other projects, so we don't have an unbiased view of who is even using the "custom bookmarklets" you mentioned.

@capjamesg
Copy link
Author

I would definitely like to see the rel value take off! The current spec is based off prior art form https://www.w3.org/Bugs/Public/show_bug.cgi?format=multiple&id=8735, where a blocker was that there was no documentation that referenced its use. If there is broader implementation interest, I plan to respond back to that thread with reference to its current state.

I edit a lot of documentation sites so I have felt the need for a standard way to find edit links for a while :D

If it's not of interest right now, feel free to close the PR.

@brc-dd
Copy link
Member

brc-dd commented May 15, 2025

I'm fine with merging it. But I want to see some interest from others first and intended usage (probably some demo video or something). Is there any real (working) extension or software that uses rel=edit to provide features?

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.

2 participants