npm 包 hexo-algolia-gmagon 使用教程

阅读时长 3 分钟读完

前端开发者大概都会用到 hexo,它是一个快速、简洁且高效的博客框架,是一款很好的高效的静态博客生成工具。而 hexo-algolia-gmagon 就是针对 hexo 博客进行搜索优化的一个 npm 包。

这篇文章将详细介绍如何使用 hexo-algolia-gmagon包来提升您的 hexo 博客的搜索效果。本文的内容可供初学者学习,同时也具备指导意义,能够帮助您更好地了解 hexo-algolia-gmagon 这个工具。

什么是 hexo-algolia-gmagon

Hexo-algolia-gmagon 是一个专门为了 Hexo 设计的 Algolia 搜索插件。Algolia 是一个实时搜索平台,可以将我们的博客飞快地搬到全世界,使得博客的搜索速度快了许多。而 hexo-algolia-gmagon 使用 Algolia 平台作为后端,所以您需要在 Algolia 上创建一个账号或者使用现有的账号来搜索您的页面。

如何使用 hexo-algolia-gmagon

首先,您需要在您的 Hexo 博客中安装 hexo-algolia-gmagon 包:

接着,在 Hexo 的根目录下的 _config.yml 中添加如下配置:

-- -------------------- ---- -------
--------
  -------------- ----------
  ------- --------------------------------
  ---------- -------
  -------
    - -----
    - -------
    - ---
  ------- ----
  ---------- ----
  ------------ -

其中,

  • applicationIDapiKey 需要您在官网上创建一个 Algolia 应用并从其中获取。
  • indexName 是您的博客在 Algolia 平台上的索引名。
  • fields 用于指定要索引的字段,这里我们指定了标题、内容和 URL 。
  • offsetchunkSize 用于控制分批保存文章到 Algolia 中,这里分批保存的文章是从博客们目录下的 xxxx/index.md 文件中抽出来的。
  • concurrency 用于控制同时可操作的文章数量。

在配置完成后,您还需要在您的主题中添加搜索框,平常的做法是新建一个 search.ejs 文件,将以下代码贴到您的主题中在合适的位置:

最后,在您的 hexo 博客根目录下使用以下命令生成进 Algolia 平台:

通过以上步骤,您的 Hexo 博客就可以实现搜索了。

结语

Hexo-algolia-gmagon 是一个真正高效的 Algolia 搜索插件,本文我们详细地介绍了它的使用方式和配置方法,希望可以对您的 Hexo 博客有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055eb581e8991b448dc60b

纠错
反馈