当前位置: 首页 > 后端技术 > Node.js

「ReStory」在Markdown中自由编写React组件(Beta)

时间:2023-04-04 00:18:41 Node.js

介绍先睹为快我们正在开发一个小型的React组件库,但遇到了一个大问题,就是如何为我们的组件库编写一个合理的文档。作为一个组件文档,我们非常希望能够展示我们的组件用例代码。是的,我们在编写文档时可以有直观的交互体验。为此,我开发了ReStory,一种文档构建工具。如果你熟悉Vuepress,你一定对它不陌生。这可以说是React版的Vuepress。ReStory的能力可以直接在Markdown文档中编写React组件。任何React组件都可以一键构建服务端渲染和客户端渲染版本,可以很好的完成SEO任务。针对技术文档优化的Markdown扩展可以让你写得更好组件文档库ReStory是建立在AntDesign之上的,所以我们直接全局使用Antd,如示例!更多功能等你PRQuickStart开始使用ReStory就像数1、2、3、4一样简单。#安装ReStory,你可能需要一些权限(sudo)npmconfigsetunsafe-permtrue&&npmi-grestore#buildanmdfileecho'#HelloReStory'>README.md#输入全局命令,注意命令末尾一个小点~restorydev.#写完构建后,输入全局命令,注意在command~restorybuild的末尾有一个小点。项目地址:ReStory文档链接(目前只有英文):Document

猜你喜欢