gulp-md-template
v1.1.4
Published
Include markdown files in an HTML template
Downloads
15
Readme
gulp-md-template
Gulp plugin uses markdown-templator to include markdown files in an HTML template.
Installation
$ npm install gulp-md-templateGulpfile
var gulp = require('gulp'),
template = require('gulp-md-template');
gulp.task('default', function () {
return gulp.src('./*.html')
.pipe(template('./partials'))
.pipe(gulp.dest('./dist'));
});Example Usage
You can include markdown files into an HTML template so that this:
<!-- ./index.html -->
<head>
<title>Example</title>
<link rel="stylesheet" href="style.css">
</head>
<body>
{{header}}
<div class="container">
{{article.md}}
</div>
</body><!-- ./partials/header.md -->
## TITLE<!-- ./partials/article.md -->
This is an article about this stuff:
- Item of intereset
- Another item of interest
- An item of non-interestTransforms to this:
<!-- ./dist/index.html -->
<head>
<title>Example</title>
<link rel="stylesheet" href="style.css">
</head>
<body>
<p><img src="logo.png" alt="Logo"></p>
<h2 id="title">TITLE</h2>
<div class="container">
<p>This is an article about this stuff:</p>
<ul>
<li>Item of intereset</li>
<li>Another item of interest</li>
<li>An item of non-interest</li>
</ul>
</div>
</body>How to contribute
- File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
- Fork the project in your account and create a new branch:
your-great-feature. - Commit your changes in that branch.
- Open a pull request, and reference the initial issue in the pull request message.
License
See the LICENSE file.