正文 目前, 我们的组件库 一共使用了三种文档工具, 分别是: Story Book Docz Dumi 下面我会根据实际的使用情况,对这三种工具做一些对比 并给出一些结论。 1. Docz 是一个高效、零配置的事件记录工具。 Docz 基于 MDX ,有许多内置的组件可以帮助你记录你的事情。 它同时支持添加插件,以便于通过 Docz 流程和数据管控很多事情。 代码示例 // Button.mdx import { Playground } from 'docz' import { Button } from '. 我们的 SSC-UI-React 组件库使用了docz, 实际效果: 3. dumi dumi 是一款为组件开发场景而生的文档工具。 其具有开箱即用,将注意力集中在组件开发和文档编写上。
└── frog.min.js.map ├── doc // 组件库文档站点 │ ├── Alert.mdx │ └── button.mdx ├── doczrc.js // docz 组件库打包产物:ESM │ ├── Alert │ ├── Button │ ├── index.js │ └── style ├── gatsby-config.js // docz 组件文档 这里使用 docz 来搭建文档站点,更具体的使用方法大家可以阅读官网文档,这里不再赘述。 :dev": "docz dev", "docz:build": "docz build", "docz:serve": "docz build && docz serve" } 线上文档站点部署 yarn docz:build cd .docz/dist now deploy vercel --production 一键发版 我们在发布新版 npm 包时会有很多步骤,这里提供一套脚本来实现一键发版
dylanaraps/pure-bash-bible Star 6515 一些用于替代外部程序的纯bash实现脚本集合,这本书也可以在leanpub上购买:https://leanpub.com/bash 8 docz https://github.com/pedronauck/docz Star 6174 ? Docz是一个高效、零配置的事件记录工具 ,Docz 基于 MDX ,有许多内置的组件可以帮助你记录你的事情。它同时支持添加插件,以便于通过 Docz 流程和数据管控很多事情。
Docz 可以根据组件的注释和 JSX 代码生成文档,并支持 Markdown、MDX 和自定义主题。 图片https://www.docz.site/#DocusaurusDocusaurus 是一个用于创建、维护和部署静态网站的工具。它适用于创建项目文档、团队文档和任何其他类型的文档。
GitHub 地址→https://github.com/hashicorp/terraform 2.5 文档工具:docz 本周 star 增长数:800+ Docz 是方便你记录事件的工具,你使用 GitHub 地址→https://github.com/pedronauck/docz 3.
4.1 father介绍 官方介绍就一句话:基于rollup和docz的库打包工具。 它的特点主要有: 基于 docz 的文档功能 基于 rollup 和 babel 的组件打包功能 支持 TypeScript 支持 cjs、esm 和 umd 三种格式的打包 esm 支持生成 mjs, 如果对docz不太了解的可以在docz官网学习使用非常简单,只要你对markdown和react熟悉,分分钟入门。 具体使用可以参考以下方式: --- name: Button route: /Button order: 3 sidebar: true --- import { Playground } from 'docz order 组件在导航条中显示的顺序 siderbar 当前页面是否显示导航条 我们根据案例可以知道mdx里面可以使用es6的导入方式来引入组件或者变量,其实还有很多配置,这里就不一一举例了,感兴趣的可以到docz
ie https://v5.getbootstrap.com/docs/5.0/getting-started/introduction/ Umi 团队推出打包工具 father 基于rollup和docz
stop} className="btn">停止观察旧值</button>
「官网地址:」 http://h5.dooring.cn/docz/source-list/V6.Dooring/v6 「技术分享:」 http://lowcode.dooring.cn/product
最近,开源项目 Docz 作者 Pedro 发表短文称繁重的开源维护工作不可持续,自己曾处于“崩溃”状态。 Pedro 表示最初为了开发 Docz,他可以提前 3 小时起床,推迟 3 小时睡觉,全力以赴地创建这个项目的经历让他“感觉很棒”。
fastdfs §参考 https://code.google.com/p/fastdfs/ 分布式文件系统(FastDFS)-Chinaunix http://portal.ucweb.local/docz 2)MFS Master节点很消耗内存 3)对于小于64KB的文件,存储利用率较低 §应用场景 1)单集群部署的应用 2)中、大型文件 §参考 http://portal.ucweb.local/docz
stop} className="btn">停止观察旧值</button>
8、docz 有些文档需要有代码效果演示,docz 就是这一类文档的专用生成工具,可以定制页面组件。
「官网地址:」 http://h5.dooring.cn/docz/source-list/V6.Dooring/v6 好啦, 今天的分享就到这啦, 如果文章对你有帮助, 欢迎 「点赞」 + 「评论」,
包括支持静态内容的展示,以及可以查看源码的实施运行效果,这方面有很多优秀的开源库,比如 StoryBook&Styleguidist,Docz 这里你需要注意一个典型的错误行为,那就是调研的时候,只调研一些基础的功能就开始做选择
://github.com/MrXujiang/best-cps 如何高效低成本的搭建简单易用的组件文档 对于组件文档, 市面上也有很多开源的工具, 比如 vue-press, storybook, docz
具体的案例可以参考: github.com/MrXujiang/b… 如何高效低成本的搭建简单易用的组件文档 对于组件文档, 市面上也有很多开源的工具, 比如 vue-press, storybook, docz
设计系统与组件化采用设计Token和跨端组件库,提升一致性与换肤效率;Storybook/Docz沉淀文档。
-- 文档 我在很多项目里都在使用 Storybook 作为文档工具,不过也有一些其他好的方案: Docusaurus:https://github.com/facebook/docusaurus Docz :https://github.com/doczjs/docz Styleguidist:https://github.com/styleguidist/react-styleguidist 最后 参考
基于 docz 的文档功能 基于 rollup 和 babel 的组件打包功能 支持 TypeScript 支持 cjs、esm 和 umd 三种格式的打包 esm 支持生成 mjs,直接为浏览器使用