docsifyjs / docsifyjs/docsify

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

Ouverte
#1,628 6 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
31.5k
Forks
5.8k
Merge moyen
9 j 8 h
PR mergées (30 j)
2

Description

## Feature request

#### What problem does this feature solve?

To cite the [Markdown Guide](https://www.markdownguide.org/extended-syntax/#footnotes):

> 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](https://www.markdownguide.org/extended-syntax/#footnotes):

```md
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.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.