init

Author: Will O'Brien

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Will O'Brien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+gulp-doctoc
+==============
+
+Inject a table of contents into your markdown files.
+
+Install
+-----------
+
+Install with [npm](https://npmjs.org/package/gulp-doctoc)
+
+```javascript
+npm install --save-dev gulp-doctoc
+```
+
+Usage
+---------
+
+```javascript
+var toc    = require('gulp-doctoc'),
+    marked = require('gulp-marked');
+
+gulp.task('markdown', function(){
+
+  gulp.src('./**/*.md')
+    .pipe(toc())
+    .pipe(marked())
+    .pipe(gulp.dest('./public/'));
+
+});
+
+```
+
+Thanks
+-------
+
+Thanks to [@thlorenz](https://github.com/thlorenz) for [doctoc](https://github.com/thlorenz/doctoc). He did all the hard work.
+
+License
+--------
+
+MIT (same as [doctoc](https://github.com/thlorenz))

index.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var through  = require('through2'),
+    doctoc   = require('doctoc/lib/transform'),
+    gutil    = require('gulp-util');
+
+module.exports = function(opts){
+  if(opts == null){opts = {};}
+  var title = opts.title || "";
+
+  var addToc = function (file){
+    var withToc = doctoc(file.contents.toString(), null, null, title);
+    file.contents = new Buffer(withToc.data, 'utf8');
+    return file;
+  };
+
+  return through.obj(function(file, enc, cb){
+    if(file.isNull()) {
+      this.push(file);
+      return cb();
+    }
+    if(file.isStream()) {
+      this.emit('error', new gutil.PluginError('gulp-doctoc', 'Streaming not supported'));
+      return cb();
+    }
+    try {
+      this.push(addToc(file));
+    } catch (e) {
+      console.log(e);
+      this.emit('error', new gutil.PluginError('gulp-doctoc', 'Error adding table of contents', e));
+    }
+    return cb();
+  });
+
+};

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "gulp-doctoc",
+  "version": "0.1.0",
+  "description": "Add a table of contents to a markdown file.",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/will-ob/gulp-doctoc"
+  },
+  "keywords": [
+    "gulpplugin"
+  ],
+  "author": "Will O'Brien <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/will-ob/gulp-doctoc/issues"
+  },
+  "dependencies": {
+    "doctoc": "^0.12.0",
+    "gulp-util": "~2.2.14",
+    "through2": "~0.4.1"
+  },
+  "devDependencies": {
+    "mocha": "~1.18.2",
+    "assert": "~1.1.1",
+    "gulp-util": "~2.2.14"
+  }
+}

test/fixture/after-w-title.md

@@ -0,0 +1,21 @@
+
+# Article
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+ 
+
+- [Hello](#hello)
+  - [World](#world)
+  - [Hi](#hi)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Hello
+
+### World
+
+### Hi
+
+
+

test/fixture/after.md

@@ -0,0 +1,21 @@
+
+# Article
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Hello](#hello)
+  - [World](#world)
+  - [Hi](#hi)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Hello
+
+### World
+
+### Hi
+
+
+

test/fixture/before.md

@@ -0,0 +1,14 @@
+
+# Article
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Hello
+
+### World
+
+### Hi
+
+
+

test/test.js

@@ -0,0 +1,50 @@
+'use strict';
+
+var assert  = require('assert'),
+    gutil   = require('gulp-util'),
+    gdoctoc = require('../index'),
+    fs      = require('fs');
+
+it('should add TOC to the markdown', function (cb) {
+
+  var stream = gdoctoc();
+
+  stream.on('data', function (file) {
+    assert.equal(file.relative, 'before.md');
+    assert.equal(file.path, 'test/fixture/before.md');
+    assert.equal(file.contents.toString(), fs.readFileSync('./test/fixture/after.md', 'utf8'));
+    cb();
+  });
+
+  stream.write(new gutil.File({
+    cwd: 'test',
+    base: 'test/fixture',
+    path: 'test/fixture/before.md',
+    contents: fs.readFileSync('./test/fixture/before.md')
+  }));
+
+  stream.end();
+});
+
+it('should allow title change', function (cb) {
+
+  var stream = gdoctoc({title: " "});
+
+  stream.on('data', function (file) {
+    assert.equal(file.relative, 'before.md');
+    assert.equal(file.path, 'test/fixture/before.md');
+    assert.equal(file.contents.toString(), fs.readFileSync('./test/fixture/after-w-title.md', 'utf8'));
+    cb();
+  });
+
+  stream.write(new gutil.File({
+    cwd: 'test',
+    base: 'test/fixture',
+    path: 'test/fixture/before.md',
+    contents: fs.readFileSync('./test/fixture/before.md')
+  }));
+
+  stream.end();
+});
+
+