go x/pkgsite:将目录添加到"跳转到"列表中

shstlldc  于 7个月前  发布在  Go
关注(0)|答案(6)|浏览(67)

对于包含许多包/目录的模块,如标准库,如果在“跳转到”对话框中列出目录将很有帮助。

示例用例

访问 https://pkg.go.dev/std
按 "f"
输入 "template",则“跳转到”对话框将列出:

  • html/template
  • text/template
  • text/template/parse
b09cbbtk

b09cbbtk1#

左侧边栏中的跳转按钮即使页面只有目录,而"f"键快捷键被禁用时也会显示出来。这个问题在#45462中被提出。在我们探索将目录添加到跳转模态框的想法时,应该将按钮设置为禁用状态。

mbzjlibv

mbzjlibv2#

https://golang.org/cl/309489提到了这个问题:content/static: disable jump button for pages without docs

woobm2wo

woobm2wo3#

当模态框不包含任何标识符时,'跳转到'按钮和模态框的行为应该是什么样的?

空的“跳转到”模态框

空状态会出现在目录页面(例如 https://pkg.go.dev/mvdan.cc/shhttps://pkg.go.dev/std)和几乎没有或没有文档的包(例如 https://pkg.go.dev/mvdan.cc/sh/_js)中。
此外,将README中的标题和目录纳入考虑可能会使这个功能更加实用。在这种情况下,空状态几乎不会出现。
感谢@georgehu 和 @fflewddur 提供用户体验方面的建议。

hmtdttj4

hmtdttj44#

与其在模态框为空时禁用“跳转到”控件,包括在该模态框中添加一个解释,说明此包没有任何可“跳转到”的内容,这将有助于人们理解为什么在某些页面上“跳转到”不起作用。我怀疑如果我们只是禁用该控件,最终我们会收到关于当人们期望它可用时,控件被禁用的错误报告。
从长远来看,我喜欢使用此控件进行整个页面的快速键盘导航的想法,但同意我们需要先对此进行更多的探索。

z18hc3ub

z18hc3ub5#

将readme标题添加到此列表似乎相当简单,如果我们决定这样做的话——我们可以让这些链接滚动到页面上的标题位置。
对于目录,你希望从跳转列表中选择一个目录会带你到该目录在页面上的位置,还是导航到该目录的页面?我们可以为源文件做类似的事情。

cnh2zyt3

cnh2zyt36#

对于目录,你希望从跳转列表中选择一个目录能将你带到该目录在页面上的位置,还是导航到该目录的页面?
好问题。这可能与其他跳转保持一致,以便停留在同一页。然后,用户可以阅读包摘要并决定是否点击链接。

相关问题