diff --git a/docs/gendocs.js b/docs/gendocs.js
index 51c84d9a64..10facc0ded 100644
--- a/docs/gendocs.js
+++ b/docs/gendocs.js
@@ -106,7 +106,7 @@ GLOBAL.window = GLOBAL.window || GLOBAL; // nomnoml expects window to be define
}
// Convert from Github-flavored Markdown to HTML
- function gfmifier() {
+ function gfmifier(renderTOC) {
var transform = new stream.Transform({ objectMode: true }),
markdown = "";
transform._transform = function (chunk, encoding, done) {
@@ -114,9 +114,11 @@ GLOBAL.window = GLOBAL.window || GLOBAL; // nomnoml expects window to be define
done();
};
transform._flush = function (done) {
- // Prepend table of contents
- markdown =
- [ TOC_HEAD, toc(markdown).content, "", markdown ].join("\n");
+ if (renderTOC){
+ // Prepend table of contents
+ markdown =
+ [ TOC_HEAD, toc(markdown).content, "", markdown ].join("\n");
+ }
this.push(header);
this.push(marked(markdown));
this.push(footer);
@@ -168,13 +170,16 @@ GLOBAL.window = GLOBAL.window || GLOBAL; // nomnoml expects window to be define
var destination = file.replace(options['in'], options.out)
.replace(/md$/, "html"),
destPath = path.dirname(destination),
- prefix = path.basename(destination).replace(/\.html$/, "");
+ prefix = path.basename(destination).replace(/\.html$/, ""),
+ //Determine whether TOC should be rendered for this file based
+ //on regex provided as command line option
+ renderTOC = file.match(options['suppress-toc'] || "") === null;
mkdirp(destPath, function (err) {
fs.createReadStream(file, { encoding: 'utf8' })
.pipe(split())
.pipe(nomnomlifier(destPath, prefix))
- .pipe(gfmifier())
+ .pipe(gfmifier(renderTOC))
.pipe(fs.createWriteStream(destination, {
encoding: 'utf8'
}));
diff --git a/docs/src/index.html b/docs/src/index.html
deleted file mode 100644
index 727523eda3..0000000000
--- a/docs/src/index.html
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-
-
-
- Open MCT Web Documentation
-
-
- Sections:
-
-
-
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000000..dbb1d36220
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,35 @@
+# Open MCT Web Documentation
+
+## Overview
+
+ Documentation is provided to support the use and development of
+ Open MCT Web. It's recommended that before doing
+ any development with Open MCT Web you take some time to familiarize yourself
+ with the documentation below.
+
+ Open MCT Web provides functionality out of the box, but it's also a platform for
+ building rich mission operations applications based on modern web technology.
+ The platform is configured declaratively, and defines conventions for
+ building on the provided capabilities by creating modular 'bundles' that
+ extend the platform at a variety of extension points. The details of how to
+ extend the platform are provided in the following documentation.
+
+## Sections
+
+ * The [Architecture Overview](architecture/) describes the concepts used
+ throughout Open MCT Web, and gives a high level overview of the platform's design.
+
+ * The [Developer's Guide](guide/) goes into more detail about how to use the
+ platform and the functionality that it provides.
+
+ * The [Tutorials](tutorials/) give examples of extending the platform to add
+ functionality,
+ and integrate with data sources.
+
+ * The [API](api/) document is generated from inline documentation
+ using [JSDoc](http://usejsdoc.org/), and describes the JavaScript objects and
+ functions that make up the software platform.
+
+ * Finally, the [Development Process](process/) document describes the
+ Open MCT Web software development cycle.
+
\ No newline at end of file
diff --git a/package.json b/package.json
index c96642129c..e753aa7bfb 100644
--- a/package.json
+++ b/package.json
@@ -31,7 +31,7 @@
"jshint": "jshint platform example || exit 0",
"watch": "karma start",
"jsdoc": "jsdoc -c jsdoc.json -r -d target/docs/api",
- "otherdoc": "node docs/gendocs.js --in docs/src --out target/docs",
+ "otherdoc": "node docs/gendocs.js --in docs/src --out target/docs --suppress-toc 'docs/src/index.md|docs/src/process/index.md'",
"docs": "npm run jsdoc ; npm run otherdoc"
},
"repository": {