Add a `dispose()` method to `Docsify` to clean up the instance
维护者通常 2 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
- 领域
- frontend
调研方向
首先定位 Docsify 类,以及路由变更监听器和锚点链接点击处理程序的设置。跟踪每个必须清理的实例资源,然后验证调用 dispose() 后,实例在不再需要时不会继续响应或渲染。
由索引模型根据 Issue 内容生成。
描述
Feature request
Add a dispose() method so that Docsify can be cleaned up when no longer needed.
What problem does this feature solve?
This is needed for embedding Docsify (https://github.com/docsifyjs/docsify/issues/799) on sites that switch to and from a view that has a Docsify instance (maybe they have multiple Docsify instances on different pages).
People currently can not clean up the instance when they will no longer render it.
What does the proposed API look like?
// later
window.$docsify.dispose() // or similar
and for people who will use the Docsify class directly,
const docsify = new Docsify(...)
// later
docsify.dispose()
How should this be implemented in your opinion?
Add a dispose method that cleans up route change listeners, anchor link click handlers, etc.
- 主要语言
- JavaScript
- 星标
- 31.5k
- 派生
- 5.8k
- 平均合并
- 2 天 14 小时
- 30 天内合并 PR
- 5
环境准备
- 提供 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 于 22 天前认领。 未关闭
难度 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 于 22 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 2 天内回复
-
In the Edge browser, the character `{docsify-updated}` is not replaced可能重新可做 @AmanUllah687 于 75 天前认领,目前没有进行中的 PR。 未关闭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
-
documentation good first issue theming
难度 2/5 1-3 小时 新手友好度 85/100
-
feature
难度 2/5 1-3 小时 新手友好度 85/100
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
drevendev/PatchPitch#2 ·
-
难度 1/5 1 小时以内 新手友好度 65/100
521xueweihan/HelloGitHub#4025 ·