GitHub-Style Footnotes #2326

DerDrodt · 2023-10-10T06:54:45Z

This PR adds the option of rendering footnotes at the bottoms in GitHub-Style, based on the implementation of notriddle.

Closes #1285.

For instance, the following markdown

### Footnotes

Footnote 1 link[^first].

Footnote 2 link[^second].

Duplicated footnote reference[^second].

[^first]: Footnote **can have markup**.

[^second]: Footnote text.

Gets rendered to:

<h3 id="footnotes">Footnotes</h3>
<p>Footnote 1 link<sup class="footnote-reference" id="fr-first-1"><a href="#fn-first">[1]</a></sup>.</p>
<p>Footnote 2 link<sup class="footnote-reference" id="fr-second-1"><a href="#fn-second">[2]</a></sup>.</p>
<p>Duplicated footnote reference<sup class="footnote-reference" id="fr-second-2"><a href="#fn-second">[2]</a></sup>.</p>
<hr><ol class="footnotes-list"><li id="fn-first" class="footnote-definition">
<p>Footnote <strong>can have markup</strong>. <a href="#fr-first-1">↩</a></p>
</li>
<li id="fn-second" class="footnote-definition">
<p>Footnote text. <a href="#fr-second-1">↩</a> <a href="#fr-second-2">↩2</a></p>
</li>
</ol>

This style is disabled by default and can be turned off via the markdown.bottom_footnotes option in the config.toml.

fixed getzola#2195

* Reuse Client when checking urls and add timeout for requests

* Implement replace_re filter * Cargo fmt * add regex caching * cargo fmt * update docs, update unit test * rename replace_re -> regex_replace

Relative links in the entry content do not currently have a base URI, so will be resolved relative to the feed URI: Given an entry with the content: <a href="some-resource.bin"> And URIS of: * entry: https://example.org/blog/some-entry/ * feed: https://example.org/atom.xml The link URI will end up as: https://example.org/some-resource.bin rather than the URI that ends up resolved in the rendered page: https://example.org/blog/some-entry/some-resource.bin The atom and RSS formats allow for an xml:base attribute (itself specified in [1]) to provide a base URI of a subset of a document. This change adds xml:base attributes to each entry, using the page permalink. This gives us something equivalent to: <entry> <content xml:base="https://example.org/blog/some-entry/"> <![CDATA[ <a href="some-resource.bin"> ]]> </content> </entry> [1]: https://www.w3.org/TR/xmlbase/ Signed-off-by: Jeremy Kerr <[email protected]>

* Fix multi-ligual json index * multi-lingual search Fix cargo fmt

…tzola#2196) * Add search into the serialized config (getzola#2165) * Only expose index_format * Create config.search struct * cargo fmt

* Fix hard link panic and add better error info to std:fs errors * cargo fmt * Remove erroneously committed config change * Remove console import; Use with context to provide additional error info * improve error wording

* Add optional decoding="async" loading="lazy" for img In theory, they can make the page load faster and show content faster. There’s one problem: CommonMark allows arbitrary inline elements in alt text. If I want to get the correct alt text, I need to match every inline event. I think most people will only use plain text, so I only match Event::Text. * Add very basic test for img This is the reason why we should use plain text when lazy_async_image is enabled. * Explain lazy_async_image in documentation * Add test with empty alt and special characters I totaly forgot one can leave the alt text empty. I thought I need to eliminate the alt attribute in that case, but actually empty alt text is better than not having an alt attribute at all: https://www.w3.org/TR/WCAG20-TECHS/H67.html https://www.boia.org/blog/images-that-dont-need-alternative-text-still-need-alt-attributes Thus I will leave the empty alt text. Another test is added to ensure alt text is properly escaped. I will remove the redundant escaping code after this commit. * Remove manually escaping alt text After removing the if-else inside the arm of Event::Text(text), the alt text is still escaped. Indeed they are redundant. * Use insta for snapshot testing `cargo insta review` looks cool! I wanted to dedup the cases variable, but my Rust skill is not good enough to declare a global vector.

…atter (getzola#2237) * Prevent spans crossing line boundaries in class formatter * Add snapshot tests for classed highlighting

* sort page.assets by filename Uses .to_str() to sort files and subfolders. The .unwrap() may need work or be replaced by unwrap_or_default(). Given earlier checks in the function it should work however. * add tests for assets sorting * fix rustfmt * use existing loop instead of windows * also check the non-recursive test * use .zip() and add assert msg

* templates:atom: add support for multiple authors Atom 1.0 [0] support multiple `<author>` entries in the feed. This commit modified the template to generate as many `<author>` as the page's metadata contains. [0] https://validator.w3.org/feed/docs/atom.html#recommendedEntryElements * Test we can have multiple authors in ATOM feeds

The `rel` and `type` HTML attributes are needed in the `base_url` (or `section.permalink`) link so feed aggregators know that's the HTML page that corresponds to the atom feed. Note: The RSS template doesn't have this issue.

…fig file not present (getzola#2262)

* use fs canonicalize to prevent path traversal * fix cargo fmt

* Add ignored_static to config * Make handle ignored static files correctly * cargo fmt * Match on relative path rather than incorrect target path * path -> partial path for serve static ignore * remove debug println * copy static directory if there is no ignored globset * Update docs * Deduplicate code with additional Option argument * cargo fmt

* template:feeds: add extra block * add missing > * Revert "add missing >" This reverts commit 45c6b9c. * Revert "template:feeds: add extra block" This reverts commit 596f7f1. * Update docs for feed templates

) * Introduce option to force directory when running the serve command * Update documentation about the force flag on the serve command * Resolve cargo fmt issue * Reword new serve flag documentation

…etzola#2287) The warning about unknown highlight languages was displayed even when code highlighting was disabled via `markdown.highlight_code = false`. This commit adds a condition to check this setting before issuing the warning, effectively suppressing it when code highlighting is disabled. Issue: getzola#2280

* Fixed "unnecessary mut" warning * Fixed minor typo * Use more than 8 threads for links checking if hardware supports it * Fixed failing azure Linux check * Avoid unnecessary HTTP requests to the same, already checked links

This allows benefitting from some bugfixes (potentially breaking but better compatibility with the reference Sass impl)

Keats · 2023-10-10T20:59:59Z

Can you clean up the commit history?

vbrandl · 2023-10-19T10:23:03Z

I don't know, if this is out of scope for this change, but currently footnotes are generated like this:

<div class="footnote-definition" id="bar"><sup class="footnote-definition-label">1</sup>
  <p>baz</p>
</div>
<div class="footnote-definition" id="baz"><sup class="footnote-definition-label">2</sup>
  <p>lul</p>
</div>

I would like to render successive footnotes in a box, which is currently not possible. Is it possible to change the generated HTML to wrap successive footnotes inside a div with a CSS class to allow styling around a list of footnotes?

<div class="footnotes-list">
  <div class="footnote-definition" id="bar"><sup class="footnote-definition-label">1</sup>
    <p>baz</p>
  </div>
  <div class="footnote-definition" id="baz"><sup class="footnote-definition-label">2</sup>
    <p>lul</p>
  </div>
</div>

That way, the footnotes-list class can be used to draw a box around any list of footnotes.

Drodt · 2023-10-19T11:58:11Z

That way, the footnotes-list class can be used to draw a box around any list of footnotes.

I'm not a 100% sure, I understand you correctly, but all footnotes in this new style are wrapped in an <ol>. You can set a border on this and have your box.

vbrandl · 2023-10-19T12:25:33Z

I'm asking, if the old style of generating footnotes could be changed to wrap the footnotes in a div with class footnotes-list

Drodt · 2023-10-19T12:26:38Z

I'm asking, if the old style of generating footnotes could be changed to wrap the footnotes in a div with class footnotes-list

For that you should open a new Issue imo.

vbrandl · 2023-10-19T12:33:40Z

Ok, so it's out of scope, as expexted. I'll look into this.

Another question: shouldn't the Github style footnotes use the same CSS class names as the old footnotes?

Keats · 2023-10-23T20:30:28Z

Another question: shouldn't the Github style footnotes use the same CSS class names as the old footnotes?

Probably? If it makes sense

Drodt · 2023-10-24T06:01:12Z

Another question: shouldn't the Github style footnotes use the same CSS class names as the old footnotes?

I could do that, of course, but I don't think that's the best approach. As far as I can tell, quite a few markdown tools use the GitHub style with these classes. In my opinion, we should follow this more standard approach.

Keats · 2023-10-26T16:01:20Z

quite a few markdown tools use the GitHub style with these classes

do you have examples?

DerDrodt · 2023-10-27T10:50:28Z

Ah, sorry. I was thinking about a different thing and mixed up the classes you were referring to. I have now added the footnote-definition class.

DerDrodt · 2023-10-27T14:10:19Z

I also noticed that pulldown-cmark has added support for GitHub-style footnotes (pulldown-cmark/pulldown-cmark#654). So the code changed by this feature can be removed if and when pulldown-cmark publishes a new release.

(The feature was added in June to the repository, the last version was published in May. It may take a while.)

Keats · 2023-10-28T12:33:15Z

Oh let's wait for that then if you don't mind, we would switch to it at the next release of pulldown-cmark anyway

aterenin · 2023-11-27T21:16:17Z

Just a note that it looks like the upstream PR was merged.

I would be very interested in having generated footnotes that use ol instead of div elements.

nikhilweee · 2024-01-27T04:34:37Z

Curious to know if this would be merged soon?

Keats · 2024-01-27T21:58:17Z

No, we'll update the library to add support when it's released

dkales · 2024-01-29T14:21:07Z

FYI, it seems that there are now new releases available: https://github.com/raphlinus/pulldown-cmark/releases/tag/v0.9.6.

si14 · 2024-01-30T11:08:51Z

Unfortunately those releases don't include pulldown-cmark/pulldown-cmark#654 yet.

kytta · 2024-02-06T11:17:40Z

https://github.com/raphlinus/pulldown-cmark/releases/tag/v0.10.0 is now out and it has the relevant footnote issue included

Keats · 2024-02-06T11:23:30Z

Sweet! That's a long list of changes, anyone interested in doing a PR? I think there are quite a few changes to make to the current parser

timonvo · 2024-02-06T16:32:48Z

@Keats I've just sent #2432 to update to the new pulldown_cmark v0.10.0 version, since I had already had most of the necessary changes ready in my personal fork.

WaffleLapkin · 2024-03-03T00:55:01Z

With #2432 merged, can this move forward?

Keats · 2024-03-03T14:04:21Z

It should probably on its own PR, with an option in the config.toml that will enable the pulldown-cmark flag. Closing this PR as it's now outdated

WaffleLapkin · 2024-03-04T15:31:15Z

Is someone in the thread willing to make a new version of this PR?

totikom · 2024-04-20T20:16:17Z

I've started working on it, you can assign me to #1285.

Keats and others added 27 commits March 19, 2023 20:37

Next version

8d16d17

print error message when no config file found (getzola#2168)

b00ae42

fixed getzola#2195

Speedup "zola check" command by reusing the Client (getzola#2171)

1ed722c

* Reuse Client when checking urls and add timeout for requests

Implement replace_re filter (getzola#2163)

6a5c241

* Implement replace_re filter * Cargo fmt * add regex caching * cargo fmt * update docs, update unit test * rename replace_re -> regex_replace

Fix multi-lingual json index (getzola#2197)

7edf92b

* Fix multi-ligual json index * multi-lingual search Fix cargo fmt

Add search.index_format into the serialized config (getzola#2165) (ge…

7448309

…tzola#2196) * Add search into the serialized config (getzola#2165) * Only expose index_format * Create config.search struct * cargo fmt

Fix typo in error message

4f77980

Hard link serve panic fix (getzola#2210)

1321a83

* Fix hard link panic and add better error info to std:fs errors * cargo fmt * Remove erroneously committed config change * Remove console import; Use with context to provide additional error info * improve error wording

Prevent spans crossing line boundaries in class-based code block form…

1778707

…atter (getzola#2237) * Prevent spans crossing line boundaries in class formatter * Add snapshot tests for classed highlighting

Fixes getzola#2250; Error instead of panic when root directory or con…

d3793cd

…fig file not present (getzola#2262)

Fix LFI in zola serve (getzola#2258)

fe1967f

* use fs canonicalize to prevent path traversal * fix cargo fmt

Update changelog

b97a1d5

Update edition

f0b984d

Update deps

57968be

template:feeds: add extra block (getzola#2263)

4474afa

* template:feeds: add extra block * add missing > * Revert "add missing >" This reverts commit 45c6b9c. * Revert "template:feeds: add extra block" This reverts commit 596f7f1. * Update docs for feed templates

Add Checking and Force Flag for Directory in Serve Command (getzola#2265

e81e139

) * Introduce option to force directory when running the serve command * Update documentation about the force flag on the serve command * Resolve cargo fmt issue * Reword new serve flag documentation

Clippy

2da4981

Update changelog

a41547c

Update grass to 0.13 (getzola#2321)

c8cc5f3

This allows benefitting from some bugfixes (potentially breaking but better compatibility with the reference Sass impl)

DerDrodt added 2 commits October 11, 2023 09:06

Implement bottom footnote feature

b7543ba

Test bottom footnotes

f33c26c

Move footnotes to new file

247b91e

Drodt added 2 commits October 27, 2023 12:48

Add class to footnote definitions

a30917e

Update snap

3a30202

Remove multiple paragraphs

d4d5afe

Keats force-pushed the next branch from 7f5d1a6 to e5f3026 Compare December 19, 2023 12:22

timonvo mentioned this pull request Feb 6, 2024

Update pulldown_cmark dep to v0.10, and add pulldown_cmark_escape dep. #2432

Merged

3 tasks

Keats closed this Mar 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub-Style Footnotes #2326

GitHub-Style Footnotes #2326

DerDrodt commented Oct 10, 2023 •

edited

Loading

Keats commented Oct 10, 2023

vbrandl commented Oct 19, 2023 •

edited

Loading

Drodt commented Oct 19, 2023

vbrandl commented Oct 19, 2023

Drodt commented Oct 19, 2023

vbrandl commented Oct 19, 2023 •

edited

Loading

Keats commented Oct 23, 2023

Drodt commented Oct 24, 2023

Keats commented Oct 26, 2023

DerDrodt commented Oct 27, 2023

DerDrodt commented Oct 27, 2023

Keats commented Oct 28, 2023

aterenin commented Nov 27, 2023

nikhilweee commented Jan 27, 2024

Keats commented Jan 27, 2024

dkales commented Jan 29, 2024

si14 commented Jan 30, 2024

kytta commented Feb 6, 2024

Keats commented Feb 6, 2024

timonvo commented Feb 6, 2024

WaffleLapkin commented Mar 3, 2024

Keats commented Mar 3, 2024

WaffleLapkin commented Mar 4, 2024

totikom commented Apr 20, 2024

GitHub-Style Footnotes #2326

GitHub-Style Footnotes #2326

Conversation

DerDrodt commented Oct 10, 2023 • edited Loading

Keats commented Oct 10, 2023

vbrandl commented Oct 19, 2023 • edited Loading

Drodt commented Oct 19, 2023

vbrandl commented Oct 19, 2023

Drodt commented Oct 19, 2023

vbrandl commented Oct 19, 2023 • edited Loading

Keats commented Oct 23, 2023

Drodt commented Oct 24, 2023

Keats commented Oct 26, 2023

DerDrodt commented Oct 27, 2023

DerDrodt commented Oct 27, 2023

Keats commented Oct 28, 2023

aterenin commented Nov 27, 2023

nikhilweee commented Jan 27, 2024

Keats commented Jan 27, 2024

dkales commented Jan 29, 2024

si14 commented Jan 30, 2024

kytta commented Feb 6, 2024

Keats commented Feb 6, 2024

timonvo commented Feb 6, 2024

WaffleLapkin commented Mar 3, 2024

Keats commented Mar 3, 2024

WaffleLapkin commented Mar 4, 2024

totikom commented Apr 20, 2024

DerDrodt commented Oct 10, 2023 •

edited

Loading

vbrandl commented Oct 19, 2023 •

edited

Loading

vbrandl commented Oct 19, 2023 •

edited

Loading