styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 geöffnet am 4. Okt. 2017

Auf GitHub ansehen
 (14 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
help wantedrequest for comments

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie, wie react styleguidist derzeit Markdown Dokumentation parst, und schlagen Sie eine Möglichkeit vor, JS/TS Dokumentationsdateien zu unterstützen, z.B. durch Erweiterung der Konfiguration und Hinzufügen eines benutzerdefinierten Resolvers.
Tech Stack
javascripttypescriptreact
Domain
frontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptTypeScriptReact
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65