You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ben-qnimble opened this issue
Apr 20, 2021
· 1 comment
Labels
bugAn error in the Docusaurus core causing instability or issues with its executionexternalThis issue is caused by an external dependency and not Docusaurus.
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
which yield two footnotes, 1 and 2. Where the markdown processor handles the numbering of the footnotes.
However, if you put the same code into Docusaurus, the footnotes section as expected -- labels are 1 and 2 respectively. But the superscript text with the link uses not the foot note number, but the text in between the [ ] when defining the foot note. I believe the expected behavior would be for the footnote label in the main section and the footnote section to match and both be the footnote number.
As you can see in the image below, the link to the second footnote has the text 'bignote' instead of '2' even though it links to the footnote that is labelled '2'.
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
Expected behavior
Second footnote in superscript should be labelled '2' and not 'bignote'
Actual Behavior
See above.
Your Environment
Clean fresh docusaurus checkout with alpha73
The text was updated successfully, but these errors were encountered:
bugAn error in the Docusaurus core causing instability or issues with its executionexternalThis issue is caused by an external dependency and not Docusaurus.
🐛 Bug Report
I can't find documentation on the Docusaurus website, but according to https://www.markdownguide.org/tools/docusaurus/, Docusaurus uses the Remarkable markdown processor. And that processor supports footnotes, as shown in their manual and also in the The Markdown Guide
Both guides have an example for using footnotes:
which yield two footnotes, 1 and 2. Where the markdown processor handles the numbering of the footnotes.
However, if you put the same code into Docusaurus, the footnotes section as expected -- labels are 1 and 2 respectively. But the superscript text with the link uses not the foot note number, but the text in between the [ ] when defining the foot note. I believe the expected behavior would be for the footnote label in the main section and the footnote section to match and both be the footnote number.
As you can see in the image below, the link to the second footnote has the text 'bignote' instead of '2' even though it links to the footnote that is labelled '2'.
shows the issue.
Have you read the Contributing Guidelines on issues?
Yes
To Reproduce
Create markdown page with
Expected behavior
Second footnote in superscript should be labelled '2' and not 'bignote'
Actual Behavior
See above.
Your Environment
Clean fresh docusaurus checkout with alpha73
The text was updated successfully, but these errors were encountered: