Add code to allow defining orders in tutorial.json#1198
Add code to allow defining orders in tutorial.json#1198dkniffin wants to merge 1 commit intojsdoc:mainfrom
Conversation
|
Hi guys, |
|
Thanks @dkniffin! What should be the name/location of the JSON file that configures ordering? |
|
@OpherV Sorry, it's been a while since I've used this. I believe the file name doesn't matter. It just needs to be a json file in the right directory. Also @hegemonic, any chance this can get merged soon? |
|
It would be really great if this PR could be accepted so this much-needed feature finally arrives. It's nuts that the order of tutorials appears to be random! |
|
Anyone....? |
|
Please....? |
|
@hegemonic I created this PR a long time ago now (and I actually no longer use jsdoc at all). Is jsdoc abandoned or what? Can this please be merged? |
|
Hate to say it but this is feeling like a bit of a ghost town: https://github.com/jsdoc/jsdoc/pulls?q=is%3Apr+is%3Aclosed |
6 participants
The docs imply that you can order the tutorials. That wasn't actually possible before. Now, you can specify a
orderattribute in the config.Resolves #1028
I also took a stab at writing tests, but couldn't figure out how to test the order of an array in jasmine (that's what this project uses, right?), so I left it out of the PR. My thought for a test would be to change this file to this:
{ "test2": { "title": "Test 2", "children": ["test3", "test6"], "order": 2 }, "test3": { "title": "Test 3", "children": { "test4": {"title": "Test 4"} }, "order": 1 } }Then, the test would go here, and look something like this: