docsifyjs / docsifyjs/docsify

Encapsulating Docsify

オープン
#2,135 コメント 6 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
31.5k
フォーク
5.8k
平均マージ
9日 8時間
マージ済み PR(30日)
2

説明

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 `Docsify` instance'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 `Docsify` class. Some of this this in #2104 in the items where we're bringing some functions into the classes as private methods.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。