styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 创建于 2017年10月4日

在 GitHub 查看
 (14 评论) (4 反应) (0 负责人)TypeScript (1,416 fork)github user discovery
help wantedrequest for comments

仓库指标

Star
 (11,091 star)
PR 合并指标
 (PR 指标待抓取)

描述

Is there anyway to declare documentation for components in JS (or TS) rather than markdown?

Having free-text (md) feels quite chaotic - writing the documentation in JS would enable us to do linting, import & share stub data, testing and have typesafety in TS.

贡献者指南

研究方向
研究 react styleguidist 当前如何解析 markdown 文档，并提出支持 JS/TS 文档文件的方法，例如通过扩展配置和添加自定义解析器。
技术栈
javascripttypescriptreact
领域
frontend
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JavaScriptTypeScriptReact
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65