uiw
uiw copied to clipboard
⚛️ @uiwjs A high quality UI Toolkit, A Component Library for React 16+.
自发布 v4 以来,积累了积累了一些问题和想法,希望在 v5 中处理好这些问题,是时候为未来的 v5 版本做一个计划了。这个计划没有明确开发时间,没有确定开发计划之前 v4 将会一直维护,在这里讨论一些 v5 开发的开发计划。 ## 文档(英文文档) 很早有人提出英文文档需求 #75,我们仍然没有计划和实力提供英文文档(因为我们没有这个需求),但是,我们计划提供一个“架子”,供社区自己补充英文文档。 - [ ] 所有组件文档支持在 GitHub 中完美预览,同时在文档网站中,支持示例预览和编辑。 - [ ] 探索组件 API 文档通过 TypeScript 自动生成 ([@microsoft/api-extractor](https://www.npmjs.com/package/@microsoft/api-extractor))。...
## 根据组件API注释自动化产生说明文档 ### 手动管理API说明文档面临的问题: 1. API变化如何追踪? 2. 怎么避免将内部api暴露到外部? 3. 怎么避免忘了导出API的类型声明? 4. 发布 alpha、beta版本的包时,api 如何管理? ### 工具 [microsoft/api-extractor](https://api-extractor.com/pages/overview/intro/) TypeScript 分析工具 - API Report 跟踪项目主入口点的所有导出,并生成一份报告,作为API审查工作流的基础。 - d.ts Rollups 类似于Webpack可以将所有 JavaScript 文件“汇总”到单个包中以进行分发,API Extractor...
主题标准文档,如何定义?
是否有可选方案,替代现有组件示例预览工具 当前工具支持在线预览,和代码编辑,但是打包体积太大,无法解决,可以放弃实时编辑。