Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Please support markdown footnotes [^1] [^note]

Offen
  • Stimmt etwas nicht?
#1,628 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 8 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
30/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript, markdown
Bereich
documentation

Rechercherichtung

Es werden keine Dateien oder Tests genannt. Beginne damit, den Einstiegspunkt für die Markdown-Analyse von Docsify zu lokalisieren, und vergleiche sein Verhalten mit der im Issue gezeigten Fußnotensyntax des Markdown Guide. Die Arbeit ist abgeschlossen, wenn Referenzen wie [^1] und Definitionen korrekt gerendert werden und die Platzierung der Fußnoten festgelegt und durch Tests abgedeckt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Feature request

What problem does this feature solve?

To cite the Markdown Guide:

Footnotes allow you to add notes and references without cluttering the body of the document.

For instance, in docsified software manuals this would help with structuring the information given better: useful background information can be given and clearly linked with the main text, yet without making the main text too full of details.

What does the proposed API look like?

According to the Markdown Guide:

A footnote[^1]

[^1] This is a footnote.
How should this be implemented in your opinion?

I'm not sure I understand this question in the context of this particular feature request.

One thing I notice it that docify authors might want to have control over the placement of footnotes: either at the end of a "page" or, alternatively, before the next same-level heading.

Are you willing to work on this yourself?

Unfortunately, I completely lack the necessary Javascript and markdown parsing experience to code this.

Vorherrschende Sprache
JavaScript
Sterne
31.5k
Forks
5.8k
Ø Merge
7 T. 18 Std.
Gemergte PRs (30 T.)
9

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docsifyjs/docsify

Alle Issues in docsifyjs/docsify

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.