Generate table of contents for (long?) notes
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- javascript, markdown
- 领域
- frontend
调研方向
未指定文件、测试或入口点。首先定位笔记编辑器及其 Markdown 标题或渲染路径,然后与维护者确认 viewport 与设置之间的行为。完成标准是长笔记显示一个可用的目录菜单,并与关闭和展开示例相匹配。
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem? Please describe.
When I have long notes, I can't see all chapters, and can't get an overview of it.
Describe the solution you'd like
If the note is longer than the viewport (or maybe 2 times the viewport, if you can compute it), provide a menu-button that will drop-down as a table of contents.
It could be on left or right, I let UX engineers do their work :)
If detecting viewport length is too much, that could be a setting : Show Table of Contents in Notes Yes/No. My guess is that people who need it for long notes will not mind seeing them also in short notes.
Describe alternatives you've considered
I could make notes shorter, but that would mean multiply notes, and managing data density at notes level. With only categories, it's a bit of a pain, and for some topics, it does not make sense to split.
Additional context
Example extracted from Wikipedia:
Closed:
Expanded:
- 主要语言
- JavaScript
- 星标
- 738
- 派生
- 162
- 平均合并
- 2 小时 40 分钟
- 30 天内合并 PR
- 39
环境准备
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
nextcloud/notes 的其他 Issue
-
bug need to reproduce
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
-
bug need to reproduce
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
feature request needs discussion
难度 1/5 1 小时以内 新手友好度 62/100
nextcloud/notes#1344 · 1 条评论 ·
维护者通常 1 天内回复
-
feature request needs discussion
难度 5/5 一周以上 新手友好度 35/100
维护者通常 1 天内回复
相似的 Issue
-
curriculum documentation quality
难度 2/5 1-3 小时 新手友好度 78/100
githubnext/gh-aw-workshop#3897 ·
维护者通常 2 天内回复
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
难度 2/5 1-3 小时 新手友好度 91/100
维护者通常 1 天内回复
-
check:failed feeds:add
难度 2/5 1-3 小时 新手友好度 70/100
iptv-org/database#36179 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复