docsifyjs / docsifyjs/docsify

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

Open
#1,628 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating Docsify’s Markdown parsing entry point and compare its behavior with the Markdown Guide footnote syntax shown in the issue. The work is done when references such as [^1] and definitions render correctly, with the placement of footnotes decided and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.