这篇文章主要介绍了反应组件文档化工具有哪些,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获、下面让小编带着大家一起了解一下。
如果没有人能够理解并找到如何使用我们的组件,那它们有什么用呢?
反应鼓励我们使用组件构建模块化程序。模块化给我们带来了非常多的好处,包括提高了可重用性。然而,如果你是为了贡献和复用组件,最好得让你的组件容易被找的到,理解和使用。你需要将其文档化。
目前,使用工具可以帮助我们实现自动化文档工作流程,并使我们的组件文档变得丰富,可视化和可交互。有些工具甚至将这些文档组合为共享组件的工作流程的组成部分。
为了轻而易举地将我们的组件文档化,我收集了一些业界流行的工具,如果你有推荐的组件也可以评论留言。
1。位
共享组件的平台
一点不仅是一个将组件文档化的工具,它还是一个开源工具,支持你使用所有文件和依赖项封装组件,并在不同应用程序中开箱即用地运行它们。
在,你可以跨应用地共享和协作组件,你所有共享组件都可以被发现,以便你的团队在项目中查找和使用,并轻松共享他们自己的组件。
在中,你共享的组件可以在你们团队中的组件共享中心找的到,你可以根据上下文,包体积,依赖项搜索组件,你可以非常快地找到已经渲染好的组件快照,并且选择使用它们。
浏览bit.dev上的组件
当你进入组件详情页时,钻头提供了一个可交互的页面实时渲染展示组件,如果该组件包含js或md代码,我们可以对其进行代码修改和相关调试。
找到想要使用的组件后,只需使用NPM或纱线进行安装即可。你甚至可以使用钻头直接开发和安装组件,这样你的团队就可以协作并一起构建。
通过一些共享组件,就不需要再使用存储库或工具,也不需要重构或更改代码,共享,文档化,可视化组件都集中在一起,并且也能实现开箱即用。
快速上手:
分享可重用的代码组件作为一个团队·一点一点
teambit/
2。故事书,Styleguidist
故事书和Styleguidist是非常棒的项目,可以帮助我们开发独立的组件,同时可以直观地呈现和文档化它们。
故事书提供了一套UI组件的开发环境。它允许你浏览组件库,查看每个组件的不同状态,以及交互式开发和测试组件。在构建库时,故事书提供了一种可视化和记录组件的简洁方法,不同的插件让你可以更轻松地集成到不同的工具和工作流中。你甚至可以在单元测试中重复使用示例来确认细微差别的功能。
Styleguidist是一个独立的反应组件开发环境并且具备实时编译指引。它提供了一个热重载的服务器和即时编译指引,列出了组件proptype并展示基于。md文件的可编辑使用示例。它支持ES6,流和打印稿,并且可以直接使用创建应用程序反应。自动生成的使用文档可以帮助Styleguidist作为团队不同组件的文档门户。
类似的工具还有UiZoo
3。Codesandbox Stackblitz和;朋友
组件在线编译器是一种非常巧妙的展示组件和理解他们如何运行的工具。当你可以将它们组合为文档的一部分(或作为共享组件的一部分)时,在线编译器可帮助你快速了解代码的工作方式并决定是否要使用该组件。
Codesandbox是一个在线编辑器,用于快速创建和展示组件等小项目。创建一些有趣的东西后,你可以通过共享网址向他人展示它.CodeSandbox具有实时预览功能,可以在你输入代码时显示运行结果,并且可以集成到你的不同工具和开发工作流程中去。
