给文档网站添加 AI 搜索

近期,观察 rspack 仓库的时候发现有个 Rspress 文档搭建库,好奇点进去看了下,发现左边有个 AI 搜索。



然后我就好奇地看了一下代码是怎么实现的,发现如下图所示:



接着,搜索相关 npm 包,找到了是如下这个网站:https://documate.site/



翻阅一下文档,目前支持的是如下,而我自己的 ChoDocs 文档网站就是基于 VitePress 的,



查看 VitePress 相关说明,如果你是新建项目那么直接可以通过:



npm create documate@latest --template vitepress


根本模版来创建。而如果跟我一样,已经根据 vitepress 官方创建了一个项目,那么也可以手动安装。


第一步:


初始化一下 npx @documate/documate init --framework vue


执行这个命令后你会发现项目中 package.json 文件有改动,装了 @documate/documate @documate/vue


同时也会添加 script 脚本:


{
"scripts": {
...
"documate:upload": "documate upload"
}
}


第二步我就截图过来了,官方文档给的还是比较详细的,具体改那块地方也加了,样式的话如果你没有完全自定义 vitepress 原有的样式,那么引入他的样式后是完全兼容的。




接着,就是比较关键的一步。毕竟我们这个是 AI 搜索,就需要后端服务了,根据文档指引可以看这里:


https://documate.site/getting-started/backend



也提供了一键部署功能,进去后会要求登录账号以及设置服务名称,我就以 chodocs 命名了。



文档里也要求了需要提供 key,看上述代码就知道了,我们也需要把 key 放入环境变量。


我折腾到这里就暂时犹豫了,虽然刚开始想折腾的时候确实感觉挺酷的,不过仔细想想好像又没太多必要,如果文档里面本身就没有很多内容的话做个 ai 搜索问答,效果不是很好,还不如用 algolia 或者一些本地搜索插件,根据关键词搜文档效果也差不多。


如下图所示:



这个 ai 搜索问答是基于你现有的文档,像当个顾问一样,所以回答好不好还是取决于你的文档内容。


结语:


我一开始还是蛮感兴趣的,不过后来仔细想想我好像还不太需要,内容还需沉淀,而且这种文档做好分类看个几次也就熟悉了。


当个折腾尝试一下也不错,知道了居然可以这样做。


(完)

0个评论
点击登录,快来和大家讨论吧~
表情
图片
暂无评论
下载 APP