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