jekyll tipue search

Búsqueda de Jekyll Tipue

Búsqueda de texto completo en Jekyll con Tipue Search. No es necesario ningún complemento. Totalmente compatible con páginas de Github.

El índice de búsqueda en tipuesearch/tipuesearch_content.js se genera con Liquid. El complemento Tipue Search jQuery utiliza Javascript para buscar en el índice y mostrar una lista de resultados.

Vea una demostración en vivo en Github Pages. El código y la configuración de la demostración se encuentran en la rama gh-pages.

Instalación

1. Agregue la carpeta assets/tipuesearch y todos los contenidos a su sitio.

2. Agregue los scripts y estilos de Tipue Search al encabezado de su tema. Algunas de estas líneas son opcionales; consulte los documentos para obtener información:

 {% 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. Agregue el formulario de búsqueda Tipue Search, la visualización de resultados y el script a su sitio. Utilice la página de búsqueda de ejemplo search.html como referencia. Establezca tipue_search_active: true en la portada de cada página o diseño donde desee mostrar los resultados de la búsqueda. Consulte la documentación de Tipue Search para configurar el formulario de búsqueda y mostrar los resultados de la búsqueda:

 <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>

Uso

Consulte la documentación de Tipue Search y explore el código para comprender cómo funciona Tipue Search y cómo integrarlo mejor en su sitio.

Incluyendo páginas y colecciones.

De forma predeterminada, solo se incluyen publicaciones en el índice de búsqueda. Las páginas y colecciones no están incluidas.

Agregue lo siguiente a _config.yml para incluir páginas y colecciones. collections es una matriz que contiene una lista de colecciones que desea incluir.

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

Excluido del índice de búsqueda

Excluir documentos individuales del índice de búsqueda con una variable inicial:

 exclude_from_search: true

Excluya múltiples archivos, etiquetas o categorías usando una configuración en _config.yml . files es una matriz que contiene una lista de rutas de archivos que se excluirán. tags y categories son matrices que contienen listas de etiquetas y categorías que desea excluir.

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