Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit d22d2ae

Browse files
committed
docs(quickstart): QS plunker opens on app/app.module.ts
- Add/fix comments to plunker `builder.js` about how to configure
1 parent def227e commit d22d2ae

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

public/docs/_examples/quickstart/ts/plnkr.json

+1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
"app/app.module.ts",
55
"index.html"
66
],
7+
"open": "app/app.module.ts",
78
"tags": ["quickstart"]
89
}

tools/plunker-builder/builder.js

+7-5
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,13 @@ class PlunkerBuilder {
5454
this.copyrights.html = `${pad}<!-- \n${copyright}\n-->`;
5555
}
5656

57-
// config has
58-
// files: [] - optional array of globs - defaults to all js, ts, html, json, css and md files (with certain files removed)
59-
// description: optional string - description of this plunker - defaults to the title in the index.html page.
60-
// tags: [] - optional array of strings
61-
// main: string - filename of what will become index.html in the plunker - defaults to index.html
57+
// Build plunker from JSON configuration file (e.g., plnkr.json):
58+
// all properties are optional
59+
// files: string[] - array of globs - defaults to all js, ts, html, json, css and md files (with certain files removed)
60+
// description: string - description of this plunker - defaults to the title in the index.html page.
61+
// tags: string[] - optional array of plunker tags (for searchability)
62+
// main: string - name of file that will become index.html in the plunker - defaults to index.html
63+
// open: string - name of file to display within the plunker as in "open": "app/app.module.ts"
6264
_buildPlunkerFrom(configFileName) {
6365
// replace ending 'plnkr.json' with 'plnkr.no-link.html' to create output file name;
6466
var outputFileName = `${this.options.plunkerFileName}.no-link.html`;

0 commit comments

Comments
 (0)