documentationjs / documentationjs/documentation
How to specify order from the API
- Vorherrschende Sprache
- JavaScript
- Sterne
- 5.8k
- Forks
- 481
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Rechercherichtung
Beginne mit docs/NODE_API.md und dem im Issue verlinkten Build-Abschnitt und verfolge anschließend im Repository, wie die Node.js API args.order verarbeitet. Bestätige die unterstützte Syntax für die Sortierung und aktualisiere die Dokumentation, damit die Option eindeutig verwendet werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, node.js
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100