styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 ouverte le 4 oct. 2017

Voir sur GitHub
 (14 commentaires) (4 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
help wantedrequest for comments

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Étudiez comment react styleguidist analyse actuellement la documentation en Markdown et proposez un moyen de prendre en charge les fichiers de documentation JS/TS, peut être en étendant la configuration et en ajoutant un résolveur personnalisé.
Stack technique
javascripttypescriptreact
Domaine
frontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptTypeScriptReact
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65