gulp-insert-md

Insert custom content to markdown file and update like a boss

Installation

1$ npm install --save-dev gulp
2$ npm install --save-dev gulp-insert-md

Usage

Gulpfile

1const gulp = require('gulp');
2const insert = require('gulp-insert-md');
3
4gulp.task('default', ['clean'], () => {
5  return gulp.src('src/**/*.md')
6    .pipe(insert({
7      // define tasks here
8      task1: (content, callback) => callback(`task1\n${content}`),
9      task2: (content, callback) => setTimeout(callback(`task2\n${content}`), 50)
10    }))
11    .pipe(gulp.dest('build'));
12});

Before

Add some markdown comments to be insert flags like below:

[insert]: # (<start|end>:<filePath>[tasks])

Tasks will be executed serially.

1# gulp-insert-md
2
3---
4[insert]: # (start:test.js)
5some old content here, will be replaced
6[insert]: # (end:test.js)
7---
8[insert]: # (start:test1.js|task1|task2)
9---
10[insert]: # (end:test2.js|task1)
11---

After

1# gulp-insert-md
2
3---
4[insert]: # (start:test.js)
5'use strict';
6console.log('test');
7[insert]: # (end:test.js)
8---
9[insert]: # (start:test1.js|task1|task2)
10task2
11task1
12'use strict';
13console.log('test2');
14[insert]: # (end:test1.js)
15---
16[insert]: # (start:test2.js)
17task1
18'use strict';
19console.log('test2');
20[insert]: # (end:test2.js|task1)
21---

Test

1$ npm run test
2$ npm run travis

License

The MIT License (MIT)

Copyright (c) 2015 LingyuCoder

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.