documentationjs / documentationjs/documentation

How to group methods by classes?

Aperta
#412 7 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
5.8k
Fork
481
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

https://github.com/documentationjs/documentation-theme-light/blob/master/screenshot.png shows the methods in the sidebar grouped by JS classes. I run the default theme or theme-light and all I get in the sidebar is all the methods across the codebase dumped out as one long list (creating, e.g., a long line of `init` entries). How do I group the methods by their associated classes and/or modules? I'm feeding all the JS files in the codebase into the `documentation build` command, if that matters. Also the `--github`, `--format`, and `--output` options are added. Thanks!

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia confrontando lo screenshot di theme-light con l’output della barra laterale predefinita e di theme-light di una build della documentazione sui file JavaScript, comprese le opzioni --github, --format e --output. Determina se il raggruppamento è configurato o richiede un chiarimento nella documentazione; il lavoro è completato quando è documentato il modo supportato per raggruppare i metodi per classi o moduli.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.