docsifyjs / docsifyjs/docsify

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

未关闭
#1,628 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
31.5k
派生
5.8k
平均合并
9 天 8 小时
30 天内合并 PR
2

描述

## 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.

贡献指南

打开贡献指南

调研方向

未指定文件或测试。首先定位 Docsify 的 Markdown 解析入口点,并将其行为与 issue 中展示的 Markdown Guide 脚注语法进行比较。当 [^1] 之类的引用和定义能够正确渲染,并且脚注的位置得到确定且有测试覆盖时,工作即告完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, markdown
领域
documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。