styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 opened on 2017年10月4日

GitHub で見る
 (14 comments) (4 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JavaScriptTypeScriptReact
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65