allow html as permalink #771
Conversation
waylan
left a comment
waylan
left a comment
There was a problem hiding this comment.
Interesting idea. I'm not 100% sure we want to do this, but I can see the usefulness of it. What if we allowed custom classes to be assigned to the link itself instead?
Either way, this needs a test and a comment in the release notes before it can be accepted.
|
Interesting change. By accepting a ElementTree object you eliminate the need to parse HTML, which can be problematic if invalid HTML is provided. However, I like this even less from a user's perspective. I still think the proper approach would be to simply add a Then you could easily do I believe that would work fine with Font-Awesome's CSS. Of course the default value of |
| if self.use_anchors: | ||
| self.add_anchor(el, el.attrib["id"]) | ||
| if self.use_permalinks: | ||
| if self.use_permalinks or isinstance(self.use_permalinks, etree.Element): |
There was a problem hiding this comment.
Needed extra check, because a bool(etree.Element("a")) will return False
|
Closed because of irrelevant changes, continued in #776. |
2 participants
I wanted to use a Font-Awesome icon as permalink for a project. So I defined TOC permalink as follows:
<i class="fas fa-link"></i>. Currently,TocTreeprocessor.add_permalinktreats permalink content as anetree.Elementtext, so the html tag will be escaped.This patch aim to allows both text and html.