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

Disable footnote backlinks in Markdown #1490

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Conversation

MrSerth
Copy link
Member

@MrSerth MrSerth commented Jun 30, 2024

These backlinks don't work reliably and are thus more harmful than useful.

These backlinks don't work reliably and are thus more harmful than useful.
@MrSerth MrSerth added enhancement ruby Pull requests that update Ruby code labels Jun 30, 2024
@MrSerth MrSerth self-assigned this Jun 30, 2024
Copy link

codecov bot commented Jun 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.64%. Comparing base (a1765d5) to head (321d1de).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1490      +/-   ##
==========================================
+ Coverage   92.46%   92.64%   +0.18%     
==========================================
  Files         103      106       +3     
  Lines        2442     2503      +61     
==========================================
+ Hits         2258     2319      +61     
  Misses        184      184              

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

Copy link
Contributor

@Mathis-Z Mathis-Z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When testing locally, this does not fix the problem you described in #1452. The converted HTML still contains class attributes. Is this expected?

@MrSerth
Copy link
Member Author

MrSerth commented Jul 1, 2024

When testing locally, this does not fix the problem you described in #1452. The converted HTML still contains class attributes. Is this expected?

Yes, that's expected. However, if you disable the new option, another link after the footnote is added, which further contains another class attribute and didn't work in my tests.

We are talking about two different things here:

HTML:

Bildschirmfoto 2024-07-01 um 10 52 57

This PR removes the ↩ link

Source Code:

Bildschirmfoto 2024-07-01 um 10 53 39

It only tackles the element with the class="reversefootnote"

My comment in #1452 is about the element with class="footnote"


As you can see, the reverse footnote is added with an href anchor. However, Since the counterpart is not added as ID to some text, it won't work (or I don't know how it should). The issue with the footnote itself still exists and is open.

@MrSerth
Copy link
Member Author

MrSerth commented Jul 30, 2024

@Mathis-Z What's the current status here? Are you fine with the changes I proposed (and see a change locally) or do you still have concerns?

@Mathis-Z
Copy link
Contributor

Mathis-Z commented Aug 1, 2024

Yes, I am fine with your changes 👍

@MrSerth MrSerth merged commit 265880e into master Aug 1, 2024
15 checks passed
@MrSerth MrSerth deleted the markdown_footnote_backlinks branch August 1, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ruby Pull requests that update Ruby code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants