Preguntas frecuentes

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Si no encuentras la respuesta a tu pregunta en este sitio, esta página te ayudará. Si aún tienes dudas, no dudes en contactarnos por Discord o avisar a nuestro equipo de soporte.

¿Qué datos recopiláis?

Guardamos los datos extraídos del markup de tu sitio web, que convertimos a un formato JSON personalizado en lugar de HTML. Estos son los datos que incluimos en el índice de Algolia DocSearch. Los selectores en tu configuración definen qué datos rastrear.

¿Dónde se alojan mis datos?

Alojamos los datos de DocSearch en servidores de Algolia, con réplicas alrededor del mundo. Puedes encontrar más detalles sobre las especificaciones técnicas del servidor aquí, e información más completa en nuestra política de privacidad.

¿Puedo usar DocSearch en páginas que no son de documentación?

El DocSearch gratuito que ofrecemos rastrea páginas de proyectos de documentación open-source o blogs técnicos. Para usarlo en otras partes de tu sitio web, necesitarás crear tu propia cuenta de Algolia y:

• Ejecutar el rastreador de DocSearch por tu cuenta

• Usar alguna de nuestras integraciones para frameworks o clientes de API

¿Pueden indexar muestras de código?

Sí, pero no lo recomendamos.

Las muestras de código son excelentes para que los humanos entiendan cómo se usa un método específico. Sin embargo, suelen requerir código repetitivo en diferentes ejemplos, lo que añade ruido a los resultados.

En su lugar, recomendamos excluir los bloques de código de la indexación (usando la opción selectors_exclude en tu configuración) y estructurar tu contenido para que los nombres de métodos aparezcan en los encabezados.

¿Por qué tengo contenido duplicado en mis resultados?

Esto ocurre cuando tienes varias URL apuntando al mismo contenido, por ejemplo ./docs, ./docs/ y ./docs/index.html.

Configuras stop_urls con todos los patrones que quieres excluir. Este ejemplo excluirá todas las URLs que terminen en / o index.html:

{
  "stop_urls": ["/$", "/index.html$"]
}

¿Por qué los cambios personalizados desde el panel de Algolia no surten efecto?

Modificar ajustes desde el panel podría ser algo que quieras hacer por varios motivos.

Cada rastreo exitoso establece los ajustes de DocSearch. Estos ajustes se sobrescribirán en el próximo rastreo. No recomendamos editar nada desde el panel. Estos cambios provienen de la propia configuración JSON.

Puedes usar el parámetro custom_settings para este propósito.

Un sitio de documentación que me gusta no usa DocSearch. ¿Qué puedo hacer?

¡Nos encantaría ayudar!

Si falta DocSearch en la documentación de una herramienta que te gusta, te animamos a abrir un issue en su repositorio explicando cómo DocSearch podría ayudar. También puedes enviarnos un email y haremos todo lo posible por ayudarte.

¿Cuántos registros crea el rastreo de DocSearch?

La propiedad nb_hits en tu configuración registra el número de registros extraídos e indexados en el último rastreo de DocSearch. Un rastreo actualiza este número automáticamente.

El scraper de DocSearch sigue la estrategia recomendada de reindexación atómica. Crea un índice temporal nuevo para almacenar los datos extraídos de tu sitio web. Cuando tiene éxito, el rastreo sobrescribe el índice antiguo definido en tu configuración con la clave index_name.

¿Por qué no se indexan mis páginas?

Rastreamos tu sitio web según tu configuración. Puede que algunas páginas falten en la búsqueda. Algunas razones posibles son:

• Asegúrate de no estar filtrando la búsqueda usando incorrectamente facetFilters. Más detalles aquí.

• Asegúrate de que otra página indexada enlace a la página faltante con una etiqueta <a/>.

• Asegúrate de proporcionar un sitemap válido desde la configuración y que este incluya la página.

¿Cómo construimos este sitio web?

Construimos este sitio con Docusaurus v2. Nos ayudó un gran hombre que nos inspiró mucho, Endi. Queremos rendir homenaje a este ser humano excepcional que siempre será parte del proyecto DocSearch. ¡Descansa en paz, compañero!

¿Cuál es el cronograma para la v3?

Estamos lanzando una versión preliminar de la v3 en Docusaurus 2. Esto nos ayudará a iterar más rápido y asegurar que estamos listos para lanzar una versión vanilla. Proporcionaremos una guía de migración para ayudarte a adoptar esta nueva versión. Si quieres más información, puedes ver la reunión técnica que hicimos sobre este tema.

¿Puedo compartir la apiKey en mi repositorio?

La apiKey que proporciona el equipo de DocSearch es una clave de solo búsqueda que puede compartirse públicamente sin riesgos. Puedes incluirla en tu sistema de control de versiones (como Git). Si ejecutas el scraper por tu cuenta, asegúrate de crear una clave de solo búsqueda y no compartas tu clave de administración.