Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 文档可以支持组件示例实时编辑吗,类似docz #623

Closed
zhangguimei opened this issue Apr 2, 2021 · 11 comments
Closed
Labels
duplicate This issue or pull request already exists enhancement New feature or request

Comments

@zhangguimei
Copy link

Description

feat: 文档可以支持组件示例实时编辑吗,类似docz

Solution

@zhangguimei zhangguimei added the enhancement New feature or request label Apr 2, 2021
@PeachScript
Copy link
Member

暂不支持,docz 只渲染 JSX 标签,但 dumi 要处理组件逻辑和依赖,复杂度会高许多,有相关经验的话可以帮 dumi 增加这个功能。

#96 重复,issue 关闭

@PeachScript PeachScript added the duplicate This issue or pull request already exists label Apr 2, 2021
@shaoqiwang-fe
Copy link

这个有规划吗

@wenbin-im
Copy link
Contributor

暂不支持,docz 只渲染 JSX 标签,但 dumi 要处理组件逻辑和依赖,复杂度会高许多,有相关经验的话可以帮 dumi 增加这个功能。

#96 重复,issue 关闭

@PeachScript 可以先用react-live来支持单文件组件的Live Code吗?CodeBlock内有多个文件依赖的先不支持。

@PeachScript
Copy link
Member

@wenbin-im react-live 应该只支持纯组件、处理不了三方依赖;在无法提供良好体验的 Playground 之前,跳 codesandbox.io 是更好的选择

@nieyao
Copy link

nieyao commented Jul 23, 2021

这块需求还是挺大的,我这边包是放在私有npm 上的,跳 codesandbox 下不了依赖,使用者没办法快速调试 demo

@huangchen1031
Copy link

因为使用私有源npm,最新也想给组件库加个这功能。看了下真是不好搞,docz和docusaurus都是基于react-live,所有第三方依赖的引入都是通过scope方式传给Playground,示例代码不是复制即可用。umi是通过预编译成文件,再通过import导入实现,这个实时编译的部分卡点很大。。。

@PeachScript
Copy link
Member

@huangchen1031 有兴趣可以调研下 sandpack?这个讨论是一年多以前的,有些结论在今天不一定成立,也许 sandpack 之类的新方案能帮助 dumi 实现真正的 demo 实时编译预览,如果可行也欢迎给 dumi 提交 PR

@huangchen1031
Copy link

@huangchen1031 有兴趣可以调研下 sandpack?这个讨论是一年多以前的,有些结论在今天不一定成立,也许 sandpack 之类的新方案能帮助 dumi 实现真正的 demo 实时编译预览,如果可行也欢迎给 dumi 提交 PR

这个也看了下,react新文档就是用的这个依赖实现的。有点在意的是sandpack官方示例都是iframe用src通过一个在线服务更新示例,这种也不支持私有npm源的第三方依赖。而react的文档iframe则没有src内容页纯粹很多,看源码似乎是用patch-package对@codesandbox/sandpack-react进行了一些魔改。这个我再研究研究,有进展在这里同步~

@huangchen1031
Copy link

@PeachScript sandpack的依赖只支持发布到npm的公共包,或者通过cdn引入的静态资源,又凉了。准备去看看code-kitchen :)

@PeachScript
Copy link
Member

@huangchen1031 看 sandbox 文档是有方案的,在内网部一个 Node.js 服务即可,https://sandpack.codesandbox.io/docs/guides/private-packages

@huangchen1031
Copy link

@huangchen1031 看 sandbox 文档是有方案的,在内网部一个 Node.js 服务即可,https://sandpack.codesandbox.io/docs/guides/private-packages

尝试了下这个方案,因为依赖溯源导致一个playground就让浏览器发了上千个请求,救命233
要不还是用react-live全局注入下scope算了

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants