Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#1,749 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 8 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
38/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
documentation, search

Rechercherichtung

Beginne mit dem Auto-Modus des Search-Plugins und dem Sidebar-Loader, einschließlich der Frage, wie loadSidebar berücksichtigt wird; verfolge, wie verschachtelte _sidebar.md-Dateien derzeit in den Index gelangen. Als erledigt gilt die Aufgabe, wenn die vorgeschlagenen sidebarPaths-Ausgangspunkte neben der Sidebar der obersten Ebene durchsucht werden, ohne dass eine manuelle Navigation oder die Auflistung jeder Dokumentationsdatei erforderlich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
JavaScript
Sterne
31.5k
Forks
5.8k
Ø Merge
7 T. 18 Std.
Gemergte PRs (30 T.)
9

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docsifyjs/docsify

Alle Issues in docsifyjs/docsify

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.