跳到主要内容

站内搜索

theme-search-algolia 是 Docusaurus 提供的一个插件,用于将 Algolia 搜索引擎 集成到 Docusaurus 网站中,允许用户在你的文档网站上快速地进行全文搜索。Algolia 是一个强大的搜索引擎,提供快速、精确的搜索体验,适用于大型网站、文档库等。

1. 安装插件

首先,你需要安装 @docusaurus/theme-search-algolia 插件。运行以下命令来安装:

npm install @docusaurus/theme-search-algolia

或者使用 yarn:

yarn add @docusaurus/theme-search-algolia

2. 配置插件

在 docusaurus.config.js 中配置 theme-search-algolia 插件,通常需要提供 Algolia 的应用ID 和 API 密钥,并且需要生成一个 搜索索引。

module.exports = {
themeConfig: {
// 添加主题配置项
algolia: {
// *你的 Algolia 应用 ID
appId: 'YourAlgoliaAppID',

// *你的 Algolia 搜索 API 密钥
apiKey: 'YourAlgoliaSearchOnlyAPIKey',

// *你的 Algolia 索引名称
indexName: 'your_index_name',

// 可选的配置项(如使用多个语言版本)
contextualSearch: true, // 启用基于当前页面上下文的搜索,推荐开启
// 你可以根据需要添加其他配置
},
},
plugins: [
[
'@docusaurus/theme-search-algolia',
{
// 配置项可以在此处定义
// 比如,你可以开启 / 禁用搜索框中的即时建议、显示或隐藏搜索按钮等
},
],
],
};