Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Better documentation on resolvers

Aperta
#244 2 commenti 5 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript, react
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione esistente per parse() e dall’esempio CLI che usa findAllComponentDefinitions. Segui come il resolver viene passato a reactDocs.parse e come il JSON generato può alimentare la generazione di Markdown; il lavoro è completato quando l’uso della libreria e l’output previsto sono documentati con sufficiente chiarezza da poter riprodurre il flusso CLI.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
3h 28m
PR unite (30g)
6

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactjs/react-docgen

Tutte le issue di reactjs/react-docgen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.