reactjs / reactjs/react-docgen

Better documentation on resolvers

Offen
#244 2 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

I am trying to write a script to generate markdown from the generated JSON output. I have reviewed the documentation for parse() and I am trying to use the findAllComponentDefinitions resolver similar to react-docgen ./myfile.js --resolver findAllComponentDefinitions -o ./docs in the command line. This is what I attempted, but it doesnt work.

const componentAPI = reactDocs.parse(data, reactDocs.findAllComponentDefinitions)
const markdown = generateMarkdown(components[i], componentAPI)

The current documentation does not seem very clear to me.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der vorhandenen Dokumentation für parse() und dem CLI-Beispiel, das findAllComponentDefinitions verwendet. Verfolge, wie der Resolver an reactDocs.parse übergeben wird und wie dessen generiertes JSON in die Markdown-Generierung einfließen kann; die Arbeit ist abgeschlossen, wenn die Verwendung der Bibliothek und die erwartete Ausgabe so klar dokumentiert sind, dass sich der CLI-Ablauf reproduzieren lässt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.