✨ feat: add search functionality (#250)
This commit is contained in:
Óscar
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Domina la configuració de tabi: guia completa"
|
||||
date = 2023-09-18
|
||||
updated = 2024-01-05
|
||||
updated = 2024-01-07
|
||||
description = "Descobreix les múltiples maneres en què pots personalitzar tabi."
|
||||
|
||||
[taxonomies]
|
||||
@@ -34,6 +34,57 @@ Per a les configuracions que segueixen aquesta jerarquia, el valor establert a u
|
||||
|
||||
---
|
||||
|
||||
## Cerca
|
||||
|
||||
| Pàgina | Secció | `config.toml` | Segueix la jerarquia | Requereix JavaScript |
|
||||
|:------:|:------:|:-------------:|:--------------------:|:--------------------:|
|
||||
| ❌ | ❌ | ✅ | ❌ | ✅ |
|
||||
|
||||
tabi permet cerca local accessible i multilingüe amb [Elasticlunr](http://elasticlunr.com/). Per activar-la, necessites:
|
||||
|
||||
1. Establir un `default_language` a `config.toml`.
|
||||
2. Establir `build_search_index = true`.
|
||||
3. Opcionalment, configurar la secció `[search]`.
|
||||
|
||||
Per exemple:
|
||||
|
||||
```toml
|
||||
base_url = "https://example.com"
|
||||
default_language = "en"
|
||||
build_search_index = true
|
||||
|
||||
[search]
|
||||
index_format = "elasticlunr_json" # O el menys eficient "elasticlunr_javascript".
|
||||
include_title = true
|
||||
include_description = true
|
||||
include_path = true
|
||||
include_content = true
|
||||
```
|
||||
|
||||
**Nota**: per suport de cerca en Xinès/Japonès, necessites utilitzar una [build personalitzada de Zola](https://github.com/getzola/zola/blob/master/Cargo.toml#L54-L55). Addicionalment, actualment no hi ha suport per a la cerca en català.
|
||||
|
||||
### Consideracions per a usuaris de Zola 0.17.X
|
||||
|
||||
Zola 0.17.X no proporciona accés a la variable `search.index_format` ([informe del bug](https://github.com/getzola/zola/issues/2165)). En utilitzar tabi, s'assumeix l'ús de l'índex JSON, que és més eficient. No obstant això, a causa d'[un altre bug](https://github.com/getzola/zola/issues/2193) solucionat en 0.18.0, l'índex JSON per a llocs multilingües no es genera correctament.
|
||||
|
||||
Els usuaris amb versions de Zola anteriors a 0.18.0 que vulguin utilitzar l'índex JavaScript necessiten establir la variable `index_format` a dos llocs:
|
||||
|
||||
```toml
|
||||
[search]
|
||||
index_format = "elasticlunr_javascript"
|
||||
|
||||
[extra]
|
||||
index_format = "elasticlunr_javascript"
|
||||
```
|
||||
|
||||
Això assegura que tabi carregui els arxius correctes. Recomanem actualitzar a Zola 0.18.0 o posterior per a una funcionalitat òptima.
|
||||
|
||||
### Detalls d'implementació
|
||||
|
||||
Per a detalls tècnics sobre la implementació de la cerca, incloent quan es carrega l'índex, característiques d'accessibilitat i altres detalls, consulta el [Pull Request #250](https://github.com/welpo/tabi/pull/250).
|
||||
|
||||
---
|
||||
|
||||
## Suport multilingüe
|
||||
|
||||
tabi ofereix suport multilingüe complet per al teu lloc Zola, des de configurar un idioma predeterminat fins a afegir tots els que vulguis. Consulta les [preguntes freqüents sobre idiomes](/ca/blog/faq-languages/) per a més informació.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Domina la configuración de tabi: guía completa"
|
||||
date = 2023-09-18
|
||||
updated = 2024-01-05
|
||||
updated = 2024-01-07
|
||||
description = "Descubre las múltiples maneras en que puedes personalizar tabi."
|
||||
|
||||
[taxonomies]
|
||||
@@ -32,6 +32,59 @@ En todos los casos, las opciones de tabi se establecen en la sección `[extra]`.
|
||||
|
||||
Para las configuraciones que siguen esta jerarquía, el valor establecido en una página reemplaza el valor de una sección, que a su vez reemplaza el valor global. En resumen: cuanto más específica sea la configuración, mayor prioridad tendrá, o `página > sección > config.toml`.
|
||||
|
||||
---
|
||||
|
||||
## Búsqueda
|
||||
|
||||
| Página | Sección | `config.toml` | Sigue la jerarquía | Requiere JavaScript |
|
||||
|:------:|:-------:|:-------------:|:---------------:|:-------------------:|
|
||||
| ❌ | ❌ | ✅ | ❌ | ✅ |
|
||||
|
||||
tabi soporta búsqueda local accesible y multilingüe con [Elasticlunr](http://elasticlunr.com/). Para activarla, necesitas:
|
||||
|
||||
1. Establecer un `default_language` en `config.toml`.
|
||||
2. Establecer `build_search_index = true`.
|
||||
3. Opcionalmente, configurar la sección `[search]`.
|
||||
|
||||
Por ejemplo:
|
||||
|
||||
```toml
|
||||
base_url = "https://example.com"
|
||||
default_language = "en"
|
||||
build_search_index = true
|
||||
|
||||
[search]
|
||||
index_format = "elasticlunr_json" # O el menos eficiente "elasticlunr_javascript".
|
||||
include_title = true
|
||||
include_description = true
|
||||
include_path = true
|
||||
include_content = true
|
||||
```
|
||||
|
||||
**Nota**: para soporte de búsqueda en Chino/Japonés, necesitas usar una [build personalizada de Zola](https://github.com/getzola/zola/blob/master/Cargo.toml#L54-L55).
|
||||
|
||||
### Consideraciones para usuarios de Zola 0.17.X
|
||||
|
||||
Zola 0.17.X no proporciona acceso a la variable `search.index_format` ([reporte del bug](https://github.com/getzola/zola/issues/2165)). Al usar tabi, se asume el uso del índice JSON, que es más eficiente. Sin embargo, debido a [otro bug](https://github.com/getzola/zola/issues/2193) solucionado en 0.18.0, el índice JSON para sitios multilingües no se genera correctamente.
|
||||
|
||||
Los usuarios con versiones de Zola anteriores a 0.18.0 que quieran usar el índice JavaScript necesitan establecer la variable `index_format` en dos lugares:
|
||||
|
||||
```toml
|
||||
[search]
|
||||
index_format = "elasticlunr_javascript"
|
||||
|
||||
[extra]
|
||||
index_format = "elasticlunr_javascript"
|
||||
```
|
||||
|
||||
Esto asegura que tabi cargue los archivos correctos. Recomendamos actualizar a Zola 0.18.0 o posterior para una funcionalidad óptima.
|
||||
|
||||
### Detalles de implementación
|
||||
|
||||
Para detalles técnicos sobre la implementación de la búsqueda en tabi, incluyendo cuándo se carga el índice, características de accesibilidad y otros detalles, consulta el [Pull Request #250](https://github.com/welpo/tabi/pull/250).
|
||||
|
||||
---
|
||||
|
||||
## Soporte multilingüe
|
||||
|
||||
tabi ofrece soporte multilingüe completo para tu sitio Zola, desde configurar un idioma predeterminado hasta añadir todos los que desees. Consulta la [preguntas frecuentes sobre idiomas](/es/blog/faq-languages/) para más información.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Mastering tabi Settings: A Comprehensive Guide"
|
||||
date = 2023-09-18
|
||||
updated = 2024-01-05
|
||||
updated = 2024-01-07
|
||||
description = "Discover the many ways you can customise your tabi site."
|
||||
|
||||
[taxonomies]
|
||||
@@ -34,6 +34,57 @@ For settings which follow this hierarchy, the value set on a page overrides the
|
||||
|
||||
---
|
||||
|
||||
## Search
|
||||
|
||||
| Page | Section | `config.toml` | Follows Hierarchy | Requires JavaScript |
|
||||
|:----:|:-------:|:-------------:|:-----------------:|:-------------------:|
|
||||
| ❌ | ❌ | ✅ | ❌ | ✅ |
|
||||
|
||||
tabi supports accessible, local multi-lingual search with [Elasticlunr](http://elasticlunr.com/). To enable it, you need to:
|
||||
|
||||
1. Set a `default_language` in `config.toml`.
|
||||
2. Set `build_search_index = true`.
|
||||
3. Optionally, configure the `[search]`.
|
||||
|
||||
Here's an example configuration:
|
||||
|
||||
```toml
|
||||
base_url = "https://example.com"
|
||||
default_language = "en"
|
||||
build_search_index = true
|
||||
|
||||
[search]
|
||||
index_format = "elasticlunr_json" # Or the less efficient "elasticlunr_javascript".
|
||||
include_title = true
|
||||
include_description = true
|
||||
include_path = true
|
||||
include_content = true
|
||||
```
|
||||
|
||||
**Note**: for Chinese/Japanese search support, you need to use a [custom Zola build](https://github.com/getzola/zola/blob/master/Cargo.toml#L54-L55).
|
||||
|
||||
### Considerations for Zola 0.17.X Users
|
||||
|
||||
Zola 0.17.X doesn't provide access to the `search.index_format` variable ([bug report](https://github.com/getzola/zola/issues/2165)). When using tabi, this variable defaults to the more efficient JSON index. However, due to [another bug](https://github.com/getzola/zola/issues/2193) fixed in 0.18.0, the JSON index for multi-language sites is not generated correctly.
|
||||
|
||||
Users with Zola versions prior to 0.18.0 who want to use the JavaScript index need to set the `index_format` variable in two places:
|
||||
|
||||
```toml
|
||||
[search]
|
||||
index_format = "elasticlunr_javascript"
|
||||
|
||||
[extra]
|
||||
index_format = "elasticlunr_javascript"
|
||||
```
|
||||
|
||||
This ensures tabi loads the right files. We recommend upgrading to Zola 0.18.0 or later for optimal functionality.
|
||||
|
||||
### Implementation Details
|
||||
|
||||
For technical details about the search implementation in tabi, including when the index loads, accessibility features, and other specifics, see the [Pull Request #250](https://github.com/welpo/tabi/pull/250).
|
||||
|
||||
---
|
||||
|
||||
## Multilingual Support
|
||||
|
||||
tabi offers comprehensive multilingual support for your Zola site, from setting a default language to adding as many as you wish. Refer to the [multilingual FAQ](blog/faq-languages/) for more information.
|
||||
|
||||
Reference in New Issue
Block a user