trentm / trentm/python-markdown2
footnote in triple tick not being escaped
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.8k
- Forks
- 459
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 4
Description
I'm in the process of making an API using this utility, and I'm running into issues generating help for the footnote extra. It looks like when you have the footnote extra added, adding
This is a paragraph with a footnote. [^note-id]
[^note-id]: This is the text of the note.
inside ```'s, it's executing itself as a footnote, rather than escaping and showing the pre tags or whatever.
tl;dr: footnotes should be escaped when using triple ticks.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue in python-markdown2 with the footnotes extra enabled and the supplied triple-backtick example. Trace how fenced code and footnotes are processed, then verify that footnote syntax inside triple backticks is rendered as literal code rather than interpreted as a footnote.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100