Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] 修正未在正文使用的脚注 #4679

Closed
ouuan opened this issue Jan 31, 2023 · 5 comments
Closed

[RFC] 修正未在正文使用的脚注 #4679

ouuan opened this issue Jan 31, 2023 · 5 comments
Labels
Discussion / 需要讨论 Further discussion is welcome RFC / 提案

Comments

@ouuan
Copy link
Member

ouuan commented Jan 31, 2023

现在有一些页面的脚注没有在正文中被使用,这存在语义和渲染结果上的问题:

我的建议是:

  • 如果不在正文中进行标注,参考资料可以列出来,但不应作为脚注
  • 不应盲目追求使用脚注,如果只是普通的参考资料,不必强行找到被标注的正文
  • 如果大家觉得脚注的样式比较好,可以考虑修改一下主题,以现在脚注的样式显示正常语义的参考资料列表
@ouuan ouuan added Discussion / 需要讨论 Further discussion is welcome RFC / 提案 labels Jan 31, 2023
@ouuan
Copy link
Member Author

ouuan commented Jan 31, 2023

现有的要不就先直接把没使用的拎出来写成 h2 > ul

@ouuan
Copy link
Member Author

ouuan commented Jan 31, 2023

GitHub 上未使用的脚注都不会渲染出来,感觉这个 mkdocs 主题也有问题

@Great-designer
Copy link
Contributor

Great-designer commented Feb 1, 2023

未使用的脚注可以作为参考资料

如果确实没有用处,不能作为参考资料,应当移除

@IdkWhatIsIdk
Copy link
Contributor

“参考资料和注释”分开写
我个人觉得脚注的样式挺好的,但是不太清楚没链接的脚注怎么弄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion / 需要讨论 Further discussion is welcome RFC / 提案
Projects
None yet
Development

No branches or pull requests

3 participants