From ec5c2d3af09e308d1d98cc08d9dbe287ff6978df Mon Sep 17 00:00:00 2001 From: Derek Kniffin Date: Mon, 18 Apr 2016 16:31:59 -0400 Subject: [PATCH] Added docs for ordering tutorials --- content/en/about-tutorials.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/content/en/about-tutorials.md b/content/en/about-tutorials.md index a3743391..11b8e730 100644 --- a/content/en/about-tutorials.md +++ b/content/en/about-tutorials.md @@ -45,10 +45,11 @@ level. You can use a JSON file to provide a title for each tutorial and indicate should be sorted and grouped in the documentation. The JSON file must use the extension `.json`. In the JSON file, you can use the tutorial identifiers -to provide two properties for each tutorial: +to provide three properties for each tutorial: + `title`: The title to display in the documentation. + `children`: The children of the tutorial. ++ `order`: Defines the order of the tutorial menu. A lower number denotes a higher spot in the menu. In JSDoc 3.2.0 and later, you can use the following formats for the JSON file: @@ -62,10 +63,12 @@ level as `tutorial1` and has no children: "title": "Tutorial One", "children": { "childA": { - "title": "Child A" + "title": "Child A", + "order": 2 }, "childB": { - "title": "Child B" + "title": "Child B", + "order": 1 } } }, @@ -89,10 +92,12 @@ at the same level as `tutorial1` and has no children: "title": "Tutorial Two" }, "childA": { - "title": "Child A" + "title": "Child A", + "order": 2 }, "childB": { - "title": "Child B" + "title": "Child B", + "order": 1 } } ```