documentationjs / documentationjs/documentation

How to specify order from the API

Aperta
#975 0 commenti 0 reazioni 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

I'm looking at the [build docs](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md#build) which contains an optional `args.order` property. This property is an array of strings or objects and is supposed to allow you to the sorting order of documentation.

I'm not able to figure out how to use this optional property to control order. Am I misunderstanding the documentation? Or is the documentation here perhaps outdated? Thanks in advance for any help you can provide!

* What version of documentation.js are you using?: 1.8.1
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): Node.js API

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con docs/NODE_API.md e con la sezione build collegata nell’issue, quindi traccia il modo in cui la Node.js API gestisce args.order nel repository. Conferma la sintassi di ordinamento supportata e aggiorna la documentazione in modo che l’opzione possa essere utilizzata senza ambiguità.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.