❤
npm
Sign UpSign In

gulp-md-template

1.1.4 • Public • Published

gulp-md-template

NPM Version Build Status Dependency Status

Gulp plugin uses markdown-templator to include markdown files in an HTML template.

Installation

$ npm install gulp-md-template

Gulpfile

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 -->
 
![Logo](logo.png)
## TITLE
<!-- ./partials/article.md -->
 
This is an article about this stuff:
 
- Item of intereset
- Another item of interest
- An item of non-interest

Transforms 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

  1. 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.
  2. Fork the project in your account and create a new branch: your-great-feature.
  3. Commit your changes in that branch.
  4. Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.

Readme

Keywords

none

Package Sidebar

Install

npm i gulp-md-template

Repository

github.com/grit96/gulp-md-template

Homepage

github.com/grit96/gulp-md-template#readme

Weekly Downloads

9

Version

1.1.4

License

MIT

Unpacked Size

10.2 kB

Total Files

29

Last publish

Collaborators

  • grit96
Try on RunKit
Report malware