-
Notifications
You must be signed in to change notification settings - Fork 49
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
feat: allow rendering footnotes without superscript #362
feat: allow rendering footnotes without superscript #362
Conversation
I'm confused, this is a suggestion with nothing in it? I don't really know how to proceed... |
@MeanderingProgrammer can you check this out when you have the time? I'm not sure what this reviewer is doing or saying, not gonna lie |
end | ||
value = converted_value | ||
else | ||
value = footnote.prefix .. text .. footnote.suffix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the purpose of this change?
To inline prefix
& suffix
when superscript = false
?
Or effectively a way to hide the ^
?
If it's the latter it strikes me as unintuitive that setting superscript = false
results in the ^
being hidden, this should be controlled by something more explicit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, would it be better to control the whole option for rendering footnotes in general with an enable
flag that defaults to true
then? Right now the rendering of the option is controlled by if superscript = true
is enabled or not, which I thought to be a little unintuitive myself.
I was trying to keep within the bounds of existing options, but maybe adding an option here for enabling rendering of footnotes may be a better way of going about this then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My intent for this change was to be able to conceal the option without needing to render everything with superscript-style characters, btw. Sorry for not making that clear in my initial PR comment.
## Details Based on: #362 Changes behavior of how footnotes are rendered. Previously setting `superscript = false` would completely disable the rendering of footnotes. Now this simply disables the conversion to superscripts. The `^` will continue to be hidden and `prefix` and `suffix` will be added to the contents. Disabling rendering for footnotes entirely is now controlled by the new `enabled` option under the `footnote` configuration. Co-Authored-By: Varun Narravula <[email protected]>
Merged this gated by an So having Setting |
When footnote rendering is enabled, the superscript can look a little ugly if a monospace font is in use. This allows rendering a footnote using the full, normal-size font even if the superscript option is turned off, rather than disabling rendering of footnotes entirely if the superscript option is disabled.