docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon pi-hole

Add proper footnotes to tutorial.md

Open rdwebdesign opened this issue 7 months ago • 5 comments

What does this PR aim to accomplish?:

Add proper footnotes to tutorial.md

By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.
  • [x] I have read the above and my PR is ready for review. Check this box to confirm

rdwebdesign avatar Apr 21 '25 16:04 rdwebdesign

Deploy Preview for pihole-docs ready!

Name Link
Latest commit 19735281a2ee54cae08aecd3d7f8bf35118365ad
Latest deploy log https://app.netlify.com/projects/pihole-docs/deploys/687c28eadfc97a0008b78f74
Deploy Preview https://deploy-preview-1235--pihole-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Apr 21 '25 16:04 netlify[bot]

I've thought about exactly this, however, it puts the footnote really at the bottom and not below the table. And it added the ugly back-refs

2025-04-21_21-55

yubiuser avatar Apr 21 '25 19:04 yubiuser

I tried to change the footnotes BACKLINK_TEXT option to use a different icon, but it didn't work. I couldn't find the correct format to use for pymdownx.extra extension options. I reverted the failed commit.

rdwebdesign avatar Apr 26 '25 06:04 rdwebdesign

I played with it and I also could not get it to work. What does work is

  - footnotes:
      SUPERSCRIPT_TEXT: "*"

which improves the situation a bit. I wonder if it's worth the change.

P.S. I noticed the lower part of the content from this site is not included in the site's TOC

yubiuser avatar Apr 26 '25 19:04 yubiuser

I think using SUPERSCRIPT_TEXT: "*" will create an issue. Every footnote reference will use just an asterisk (without numbers). There will be no way to differentiate them. This would work on this page, since all 4 references point to the same note, but if another page has 2 different notes, both will be marked with *.

The default value (SUPERSCRIPT_TEXT: {}) automatically creates numbered references.

Examples: This line has a footnote[^a]. It will use 1 as reference. This other line has the same footnote[^a] and one more time[^a]. This will also point to note 1. Now this line has a different footnote[^b] and it needs a different reference. It will point to 2. Using just an asterisk will mix both notes.

The only difference here on Github is: each back link shows a small index, but they are just ugly as the mkdocs version.

[^a]: Footnote for the first and second lines. [^b]: Footnote for the last line. If both notes used asterisks, readers would be confused.

rdwebdesign avatar Apr 26 '25 22:04 rdwebdesign

I think you can "Squash and merge" this one.

rdwebdesign avatar Jul 19 '25 23:07 rdwebdesign