styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 aberto em 4 de out. de 2017

Ver no GitHub
 (14 comments) (4 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
help wantedrequest for comments

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador

Direção de pesquisa
Investigue como o react styleguidist atualmente analisa a documentação em markdown e proponha uma maneira de suportar arquivos de documentação JS/TS, talvez estendendo a configuração e adicionando um resolvedor personalizado.
Pilha de tecnologia
javascripttypescriptreact
Domain
frontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptTypeScriptReact
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65