Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Allow search index starting points for additional sidebar files in nested folders

Abierto
  • ¿Algo no está bien?
#1,749 1 comentario 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
documentation, search

Línea de trabajo

Comienza con el modo automático del plugin de búsqueda y el cargador de la barra lateral, incluido cómo se respeta loadSidebar; rastrea cómo los archivos _sidebar.md anidados entran actualmente en el índice. Se considera completado cuando los puntos de inicio de sidebarPaths propuestos se buscan junto con la barra lateral de nivel superior, sin requerir navegación manual ni enumerar cada archivo de documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement needs discussion

Feature request

What problem does this feature solve?

Search in Docsify works by indexing the top level sidebar content. This is fine, but as a set of documentation grows there will likely be folders added, and the sidebar continues to grow. In order to limit the growth of the sidebar, we can use nested _sidebar.md files in subfolders - problem solved.

If you then check the search index via inspecting your browser's local storage, you don't see any of the content from nested _sidebar.md files until you manually navigate to them. This is because Docsify is not loading these, which is expected behavior.

The search plugin allows an auto mode, or you can manually list the path to every file in your documentation and they'll all be indexed. For large documentation sites this is not workable.

What does the proposed API look like?

It would be great if we had a new configuration option for search, where we could index sidebarPaths (or similar). These would not need to be indexed directly, but would be used as starting points for the index since they do contain links to everything accessible in that folder.

search : {
  paths: 'auto',
  sidebarPaths : [
    '/folder'
    '/team-guidelines'
  ]
}
How should this be implemented in your opinion?

With the above config, while still working in "auto" mode, instead of only looking at /_sidebar.md search would additionally look at /folder/_sidebar.md and /team-guidelines/_sidebar.md.

This should honor loadSidebar if configured, so that people can call their sidebar whatever they like but still search it.

Are you willing to work on this yourself?

Yes, but I'm not a very experienced Javascript developer so I'm likely not the best fit.

Lenguaje dominante
JavaScript
Estrellas
31.5k
Forks
5.8k
Merge medio
2 d 14 h
PR fusionados (30 d)
5

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docsifyjs/docsify

Todos los issues de docsifyjs/docsify

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.