Changed markdown.json options, added heading option for table of cont…

…ents
sethen · Mar 6, 2015 · 9bf262c · 9bf262c
1 parent 28c6d9a
commit 9bf262c
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+# Table of Contents
+
 * [markdown-include](#markdown-include)
   * [Compile your markdown files](#compile-your-markdown-files)
   * [Make a table of contents](#make-a-table-of-contents)
@@ -69,12 +71,12 @@ node path/to/markdown-include.js path/to/markdown.json
 
 `markdown.json` can be populated with the following options:
 
-| Option            | Type          | Description                                                                |
-|:-----------------:|:-------------:|:--------------------------------------------------------------------------:|
-| `build`           | String        | File path of where everything should be compiled, like `README.md`         |
-| `files`           | Array         | Array of files to to compile                                               |
-| `tableOfContents` | Boolean       | `true` to build table of contents dynamically                              |
-
+| Option                    | Type          | Description                                                                |
+|:-------------------------:|:-------------:|:--------------------------------------------------------------------------:|
+| `build`                   | String        | File path of where everything should be compiled, like `README.md`         |
+| `files`                   | Array         | Array of files to to compile                                               |
+| `tableOfContents`         | Object        | Object to hold options for table of contents generation                    |
+| `tableOfContents.heading` | String        | Heading for table of contents, added to the `tableOfContents` object       |
 
 # How It Works
 

diff --git a/docs/how_to_use.md b/docs/how_to_use.md
@@ -10,9 +10,9 @@ node path/to/markdown-include.js path/to/markdown.json
 
 `markdown.json` can be populated with the following options:
 
-| Option            | Type          | Description                                                                |
-|:-----------------:|:-------------:|:--------------------------------------------------------------------------:|
-| `build`           | String        | File path of where everything should be compiled, like `README.md`         |
-| `files`           | Array         | Array of files to to compile                                               |
-| `tableOfContents` | Boolean       | `true` to build table of contents dynamically                              |
-
+| Option                    | Type          | Description                                                                |
+|:-------------------------:|:-------------:|:--------------------------------------------------------------------------:|
+| `build`                   | String        | File path of where everything should be compiled, like `README.md`         |
+| `files`                   | Array         | Array of files to to compile                                               |
+| `tableOfContents`         | Object        | Object to hold options for table of contents generation                    |
+| `tableOfContents.heading` | String        | Heading for table of contents (use markdown syntax if desired)             |
diff --git a/markdown-include.js b/markdown-include.js
@@ -109,7 +109,13 @@
 
 				if (options.tableOfContents) {
 					compileHeadingTags(file);
-					build[file].parsedData = tableOfContents + '\n\n' + build[file].parsedData;
+
+					if (options.tableOfContents.heading) {
+						build[file].parsedData = options.tableOfContents.heading + '\n\n' + tableOfContents + '\n\n' + build[file].parsedData;
+					}
+					else {
+						build[file].parsedData = tableOfContents + '\n\n' + build[file].parsedData;
+					}
 				}
 
 				writeFile(options, build[file].parsedData);

diff --git a/markdown.json b/markdown.json
@@ -1,5 +1,7 @@
 {
 	"build" : "README.md",
 	"files" : ["./docs/_README.md"],
-	"tableOfContents": true
+	"tableOfContents": {
+		"heading": "# Table of Contents"
+	}
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "markdown-include",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Include markdown files into other markdown files with C style syntax.",
   "main": "markdown-include.js",
   "repository": {