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]