摘要：介绍先睹为快我们在开发一个小小的组件库，但是我们遇到了一个大难题，那就是为我们的组件库书写一个合理的文档。为了达到这一点，我开发一款文档构建工具。
介绍
先睹为快
我们在开发一个小小的 React 组件库，但是我们遇到了一个大难题，那就是为我们的组件库书写一个合理的文档。
作为组件文档，我们非常希望我们的组件用例代码能够展现出来，是的我们在书写文档的时候，能够有直观的交互体验。
为了达到这一点，我开发一款文档构建工具 ReStory。如果熟悉 Vuepress 的同学一定不陌生，这可以说是 Vuepress 的 React 版本。
ReStory 的能力能够直接在 Markdown 文档中书写 React 组件，任意的 React 组件
一键构建服务端渲染和客户端渲染版本，能够很好的完成 SEO 的任务
为技术文档而优化的 Markdown 拓展，能够让你更好的完成组件文档库的书写
ReStory 构建在 Ant Design 之上，因此，我们直接在全局使用 Antd，就像例子中一样！
更多能力等你 PR
快速开始开始使用 ReStory 非常的简单，就像数 1、2、3、4一样。
# 安装 ReStory，你可能需要一些权限 (sudo) npm config set unsafe-perm true && npm i -g restory # 构建一个 md 文件 echo "# Hello ReStory" > README.md # 输入全局命令，注意命令的最后有一个小点～ restory dev . # 当你书写完成以后构建，输入全局命令，注意命令的最后有一个小点～ restory build .
项目地址：ReStory
文档链接（目前只有英文）：Document
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/94987.html
摘要：介绍先睹为快我们在开发一个小小的组件库，但是我们遇到了一个大难题，那就是为我们的组件库书写一个合理的文档。为了达到这一点，我开发一款文档构建工具。 介绍 先睹为快showImg(https://segmentfault.com/img/remote/1460000014854151); 我们在开发一个小小的 React 组件库，但是我们遇到了一个大难题，那就是为我们的组件库书写一个合理...
摘要：将处理所有相关的东西并且在上部署该文件。这里将使用上一节已经创建的文件。使用构建应用使用构建同样非常简单。使用构建包如要使用打包项目，只需在终端中执行命令，即可在项目目录中得到文件夹。其在社区也得到了广泛的使用。 译者注：最近看到 Poi 这个也是打着零配置特点（Parcel：莫名躺枪？）的 JavaScript 打包工具，发现其在 Github 有着 3000+ Star 的同时在中...
阅读 3494·2021-09-23 11:32
阅读 2092·2021-09-06 15:01
阅读 1417·2021-08-18 10:24
阅读 3190·2019-12-27 11:44
阅读 3463·2019-08-30 15:52
阅读 2378·2019-08-30 11:11
阅读 524·2019-08-29 17:27
阅读 457·2019-08-29 16:22
