-
Notifications
You must be signed in to change notification settings - Fork 240
Examples
nene edited this page Aug 8, 2012
·
2 revisions
The --examples
options allows you to specify a JSON file which should have the following structure:
[
{
"title": "Combination Examples",
"items": [
{
"name": "feed-viewer",
"title": "Feed Viewer",
"description": "RSS feed reader example application.",
"url": "feed-viewer/feed-viewer.html",
"icon": "feed-viewer/feeds.gif",
"status": "updated"
},
{
"name": "web-desktop",
"text": "Web Desktop",
"description": "A desktop in the browser using Ext components.",
"url": "http://www.example.com/desktop.html",
"icon": "http://www.example.com/desktop.gif",
"status": "updated"
},
...
]
},
...
]
The url
specifies the example file relative to --examples-base-url
option which defaults to extjs-build/examples/
. You need to copy all the examples by yourself to jsduck-output/extjs-build/examples/
directory, or into some other directory you specify with --examples-base-url
option.
Examples are still a big hack... look at the Inline Examples section for something more solid.