Encapsulating Docsify
維護者通常 8 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- javascript
研究方向
先閱讀 #2104 中參照的封裝檢查清單與相關類別變更。整理進度列、路由和模組層級狀態的需求，然後將完成定義為：支援可設定的進度列位置、可選的虛擬路由與外部控制路由，以及每個實例的狀態，同時不破壞預設值。
由索引模型根據 Issue 內容生成。
描述
We need allow the ability to fully encapsulate Docsify features and state.
With encapsulation, it will be possible later on to mount any number of Docsify instances anywhere in a web site, as well as become possible to wrap Docsify as a React/Vue/Svelte/etc component that can be used in any framework.
Encapsulation changes:
- progress bar currently appends to body. There should be an option to provide the location where it should be appended. It can default to body for backwards compatibility.
- Routing: it currently assumes control of the address bar. For backwards compatibility, this can be the default.
- We need an option to make it route virtually, without touching the address bar, for cases when that is desirable
- Perhaps add the ability to listen to a
Docsifyinstance's route changes, so that they can be mapped to the address bar in a custom way. Also allow setting Docsify's route from outside, so that a website managing multiple instances can "paginate" Docsify manually.
- Some Docsify state is at the module level (singleton), including the aforementioned progress bar, but also including state variables. We should bring state into the
Docsifyclass. Some of this this in #2104 in the items where we're bringing some functions into the classes as private methods.
- 主要語言
- JavaScript
- 星號
- 31.6k
- 分支
- 5.8k
- 平均合併
- 7 天 18 小時
- 30 天內合併 PR
- 9
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
docsifyjs/docsify 的其他 Issue
-
Query parameter values are truncated at a second equals sign可能已有人在做 @xu91102 於 26 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 88/100
維護者通常 8 天內回覆
-
bug Triage
難度 3/5 1-2 天 新手友好度 66/100
docsifyjs/docsify#2839 · 1 則留言 ·
維護者通常 8 天內回覆
-
Cached AJAX responses lose status metadata exposed through vm.route.response可能已有人在做 @xu91102 於 26 天前認領。 未關閉
難度 3/5 1-2 天 新手友好度 68/100
維護者通常 8 天內回覆
-
In the Edge browser, the character `{docsify-updated}` is not replaced可能重新可做 @AmanUllah687 於 79 天前認領，目前沒有進行中的 PR。 未關閉wait for information
難度 4/5 3-5 天 新手友好度 35/100
docsifyjs/docsify#2681 · 11 則留言 ·
維護者通常 8 天內回覆
-
feature request Triage
難度 4/5 3-5 天 新手友好度 38/100
docsifyjs/docsify#2643 · 5 則留言 ·
維護者通常 8 天內回覆
查看 docsifyjs/docsify 的全部 Issue
相似的 Issue
-
[Bug] Pitch Converter gives the wrong octave for B♯, C♭, B𝄪 and C𝄫可能已有人在做 @bhuvan-somisetty 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
sugarlabs/musicblocks#9765 ·
維護者通常 1 天內回覆
-
documentation good first issue help wanted
難度 2/5 1-3 小時 新手友好度 82/100
adaumsilva/OrchestrAI#51 ·
-
難度 2/5 1-3 小時 新手友好度 84/100
Jason-Vaughan/TangleClaw#2546 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
rubyjs/mini_racer#449 ·
-
area:integration enhancement good first issue help wanted
難度 2/5 1-3 小時 新手友好度 74/100