documentationjs / documentationjs/documentation

Separate doc files for each module

Aperta
#552 5 commenti 8 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
JavaScript
Stelle
5.8k
Fork
481
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Hi and thanks for great tool.

I was wondering if there is a way to generate separate `markdown` files for each module?

Like if I have `src/main.js`, `src/utils.js`, I want `src/main.md` and `src/utils.md` with correct linking if they have intersection.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia tracciando l'output attuale della documentazione dello strumento e i punti di ingresso per il collegamento dei moduli; la richiesta fornisce src/main.js e src/utils.js come input di esempio. Determina come vengono rappresentati i percorsi di output e i link tra moduli, quindi verifica che vengano generati file separati src/main.md e src/utils.md con link corretti.

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

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.