手动给 docusaurus 添加一个搜索
新版博客用 docusaurus 重构已经有些日子了,根据 docusaurus 的文档上也申请了 Algolia,想一劳永逸的解决博客的搜索问题。但是流水有意,落花无情。
algolia 总是不给我回复,我只能对着 algolia 的申请页面仰天长叹。
正常情况的申请
按照 docusaurus 官方文档上说的,当我们需要搜索的时候,打开https://docsearch.algolia.com/apply/填一下申请,提交就行了。
但是可惜的是,我填好资料,点这个 join the program 很多次了,就是没有反应。
怎么办呢?我仔细检查了它的官方文档,看他的描述说是需要等待 2 个星期。但是 2 个星期实在太久了,在我们只争朝夕的今天,怎么行。
还好,我看到它还有一种手动上传的办法,笨是笨了点,总比没有的好。那就开始吧。
手动上传
首先我们得去 Algolia 上注册一个账号,然后在这里需要创建一个应用:
应用的旁边,需要创建一个 index 用来存储搜索数据:
这样,前期的准备工作就做好了。
再在 api 设置中找到 APPLICATION_ID 和 API_KEY。把他们保存到.env 文件中:
APPLICATION_ID=YOUR_APP_IDAPI_KEY=YOUR_API_KEY
注意,这里的 API_KEY 最好是 Admin API Key,因为会有一些权限需要。
如果是 Admin API Key 的话,记得不要分享给别人,这个 key 的权限比较大,可以删除和更新你的 index 数据。
设置配置文件
接下来,我们还需要一个配置文件。用来配置爬虫信息。下面是一个最基本的配置信息。
其中 index_name 就是我们刚刚在网站上创建的 index_name。当 DocSearch scraper 程序跑起来的时候,你会发现有一个临时的index_name
+ _tmp 索引被创建。
别担心,在程序执行完毕之后,会把这个 tmp index 会替换最终的 index。
start_urls 包含的是要开始爬取的链接地址。爬虫会循环爬取链接里面的 a 标签,除非是遇到了 stop_urls。另外爬虫不会爬取其他域名的链接。
selectors 是用于创建记录层次结构的所有 CSS 选择器。其中 text 是强制,必须要有的。
如果你对不同的 url 有不同的 selector 方案,那么可以给不同的 url 配置不同的 selectors_key,如下所示:
好了,基本的配置就这些了。
运行爬虫脚本
现在可以运行爬虫脚本了,这里有两个选择,一是跑 docker,方便快捷。二是从源代码运行,这个就比较麻烦了。
这里我只是希望博客可以有搜索功能,所以源码什么的就算了吧,我们直接跑 docker 命令:
run -it --env-file=.env -e "CONFIG=$(cat flydean.conf | jq -r tostring)" algolia/docsearch-scraper
过一会就运行起来了。但是我们看看日志:
DocSearch: http://www.flydean.com/07-python-module/ 0 records)DocSearch: http://www.flydean.com/08-python-io/ 0 records)DocSearch: http://www.flydean.com/09-python-error-exception/ 0 records)DocSearch: http://www.flydean.com/06-python-data-structure/ 0 records)
Crawling issue: nbHits 0 for myblog
nb_hits 表示的是 DocSearch 提取和索引的记录数。
怎么是 0 records?难道什么都没有爬到?
直觉是我的 start_urls 不太对,我们把它换成 sitemap.xml 再试一次:
还是同样的错误。
没办法,再去仔细读一下配置文件的说明。
终于发现了问题,原来这里的 selectors 写的有问题,#content header h1 表示的是在 ID 为content
的元素内部,寻找所有属于header
类的元素,并在这些元素内部寻找所有的<h1>
元素。但是在 docusaurus V3 版本中已经发生了变化。
我们把它改写成这样:
再运行一次,这次终于有数据了。
回到网站上看看,已经有数据上传上来了:
好了,我们在 docusaurus.config.ts 中配置一下,看看效果:
我们在网站上试试效果:
完美,遇到问题的小伙伴可以私信我哟!
版权声明: 本文为 InfoQ 作者【程序那些事】的原创文章。
原文链接:【http://xie.infoq.cn/article/de7cda67e846e359410b2935f】。文章转载请联系作者。
评论