trentm / trentm/python-markdown2

[shadow] innerHTML of backlink of footnotes extra

Open
#37 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.8k
Forks
459
Avg merge
2d 19h
Merged PRs (30d)
4

Description

_This is a _shadow issue* for Issue 37 on Google Code (from which this project was moved).
Added 2010-05-07T10:32:21.000Z by livibet...@gmail.com.
Labels: Type-Defect, Priority-Medium.
Please make updates to the bug there.*

Original description

I want to suggest an option for footnotes extra, a way to specify the 
backlink's innerHTML (innerText):

    $ markdown2 --extras=footnotes=^ file.mkd

It generates "^" as a backlink instead of "↩" (↩), user can choice 
whatever they want.

The reason to have this option is not all fonts have `&#8617` glyph. Of 
course, we can use CSS to specify another font which have that glyph. But, 
for me, I don't want to have different font even I couldn't tell the 
difference.

The patch has `backlink_innerhtml` variable in `_add_footnotes()`, it's not 
a proper name because this extras splitter:

    splitter = re.compile("[,;: ]+")

In HTML, using space is inevitable, you can't give a `<img>` or use a plain 
text &quot;Go Back&quot;.  But I don't think they are really needed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Google Code issue, since this shadow issue explicitly says updates belong there. In the project, inspect the footnotes extra and its _add_footnotes() entry point, including the extras splitter. Done means users can choose custom backlink innerHTML without preventing plain text or HTML values.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.