search

star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
https://www.showdoc.com.cn
Other
12.27k stars 2.19k forks source link

搜索忽略功能 #2268

Open QSQ-QAQ opened 2 months ago

QSQ-QAQ commented 2 months ago

我们团队使用 showdoc 遇到一个问题，是这样的随着长时间的迭代 文档的已经越来越大了，并且随着 我们在该api页面 上写的示例代码 和注释 使得，在搜索时会出现非常多的选项，并且卡顿时间也在增长，所以我们希望能增加 一个搜索忽略的功能 ，例如 我们写的示例代码中的代码块 不希望被搜索栏 搜索到。 感谢

star7th commented 2 months ago

目前就是简单得关键字匹配，暂时无法做到自动忽略代码块。建议可以使用下其他精确一点关键字去搜索

QSQ-QAQ commented 2 months ago

因为我们是将api在线文档 开放给其他需要的客户去看，有不少的客户向我们反馈该问题，所以我就来反馈一下，看能优化客户使用的体验感。请问后续会考虑该功能吗

star7th commented 2 months ago

比如说，具体怎样的文档，搜素词是什么。我要具体看看到底是需求需要，还是搜素词过于模糊不准确

star7th commented 2 months ago

最好发链接来看看

QSQ-QAQ commented 2 months ago

http://engine-doc.hzzaien.com/web/#/68/21141 这个是我们其中之一的在线文档 image 当我 搜索ListView时 会将示例中所有包含该 字段页面全部展示出来 ，目前我们是尽量减少示例代码，使搜索能更加精准，但是客户认为我们应该增加示例代码，这样能更详细的展示api 的用法

star7th commented 2 months ago

我觉得你们设置一个接口速查表是正确的，http://engine-doc.hzzaien.com/web/#/68/36486 ，客户在这个页面 ctrl + F 便可以找接口了。 对于你说的搜索场景，我觉得这是比较小众的场景。暂时不为此增加功能。就好像 百度搜索，搜索出来的结果太多的话，应该尝试更换更准确的搜索词。"ListView"这样的关键字实在太模糊了，不应该用来做搜索关键字

QSQ-QAQ commented 2 months ago

好的 感谢