jekyll tipue search

Jekyll Tipue 搜索

使用 Tipue Search 在 Jekyll 中进行全文搜索。无需插件。与 Github Pages 完全兼容。

tipuesearch/tipuesearch_content.js处的搜索索引是使用 Liquid 生成的。 Tipue Search jQuery 插件使用 Javascript 来搜索索引并显示结果列表。

查看在 Github Pages 上运行的实时演示。演示的代码和配置位于 gh-pages 分支中。

安装

1. 将assets/tipuesearch文件夹和所有内容添加到您的网站。

2. 将 Tipue 搜索脚本和样式添加到您的主题头部。其中一些行是可选的，请参阅文档以获取信息：

 {% if page.tipue_search_active or layout.tipue_search_active %}
<link rel="stylesheet" href="{{ "/assets/tipuesearch/css/normalize.css" | relative_url }}">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="{{ "/assets/tipuesearch/tipuesearch_content.js" | relative_url }}"></script>
<link rel="stylesheet" href="{{ "/assets/tipuesearch/css/tipuesearch.css" | relative_url }}">
<script src="{{ "/assets/tipuesearch/tipuesearch_set.js" | relative_url }}"></script>
<script src="{{ "/assets/tipuesearch/tipuesearch.min.js" | relative_url }}"></script>
{% endif %}

3. 将 Tipue Search 搜索表单、结果显示和脚本添加到您的站点。使用示例搜索页面search.html作为参考。在要显示搜索结果的每个页面或布局的 front-matter 中设置tipue_search_active: true 。有关搜索表单的配置和搜索结果的显示，请参阅 Tipue Search 文档：

 <form action="{{ page.url | relative_url }}">
  <div class="tipue_search_left"><img src="{{ "/assets/tipuesearch/search.png" | relative_url }}" class="tipue_search_icon"></div>
  <div class="tipue_search_right"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required></div>
  <div style="clear: both;"></div>
</form>

<div id="tipue_search_content"></div>

<script>
$(document).ready(function() {
  $('#tipue_search_input').tipuesearch();
});
</script>

用法

请参阅 Tipue Search 文档并浏览代码以了解 Tipue Search 的工作原理以及如何最好地将其集成到您的网站中。

包括页面和集合

默认情况下，搜索索引中仅包含帖子。不包括页面和集合。

将以下内容添加到_config.yml以包含页面和集合。 collections是一个数组，其中包含要包含的集合列表。

 tipue_search:
  include:
    pages: true
    collections: [apples, oranges]

从搜索索引中排除

使用 front-matter 变量从搜索索引中排除单个文档：

 exclude_from_search: true

使用_config.yml中的设置排除多个文件、标签或类别。 files是一个数组，包含要排除的文件路径列表。 tags和categories是包含要排除的标签和类别列表的数组。

 tipue_search:
  exclude:
    files: [search.html, _apples/gragg.md, _oranges/valencia.md]
    tags: [tag1, tag2]
    categories: [category1, category2]