styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 aperta il 4 ott 2017

Vedi su GitHub
 (14 commenti) (4 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wantedrequest for comments

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga come react styleguidist analizza attualmente la documentazione markdown e proponi un modo per supportare file di documentazione JS/TS, magari estendendo la configurazione e aggiungendo un resolver personalizzato.
Tech stack
javascripttypescriptreact
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScriptTypeScriptReact
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65