Allow search index starting points for additional sidebar files in nested folders
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
- 領域
- documentation, search
調査の方向性
検索プラグインの自動モードとサイドバーのローダーから始め、loadSidebar がどのように尊重されるかを含めて確認します。ネストされた _sidebar.md ファイルが現在どのようにインデックスに入るのかを追跡します。提案された sidebarPaths の開始地点がトップレベルのサイドバーと併せて検索され、手動でのナビゲーションやすべてのドキュメントファイルの列挙を必要としなければ完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- JavaScript
- スター
- 31.5k
- フォーク
- 5.8k
- 平均マージ
- 2日 14時間
- マージ済み PR（30日）
- 5
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docsifyjs/docsify のほかの issue
-
Query parameter values are truncated at a second equals sign対応中かも @xu91102 が 23 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 2 日以内に返信
-
bug Triage
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
メンテナーはふだん 2 日以内に返信
-
Cached AJAX responses lose status metadata exposed through vm.route.response対応中かも @xu91102 が 23 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
In the Edge browser, the character `{docsify-updated}` is not replaced再び着手できるかも @AmanUllah687 が 76 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンwait for information
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
docsifyjs/docsify#2681 · コメント 11 件 ·
メンテナーはふだん 2 日以内に返信
-
feature request Triage
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
docsifyjs/docsify#2643 · コメント 5 件 ·
メンテナーはふだん 2 日以内に返信
docsifyjs/docsify の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
maintenance
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
alphagov/accessible-autocomplete#826 ·
メンテナーはふだん 4 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
olahol/react-tagsinput#229 ·
-
[BUG] npm pkg delete removes the first array item for a nonexistent property対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
jonathanong/no-mistakes#2260 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信