gulp-md-template
Include markdown files in an HTML template
Last updated 2 years ago by grit96 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gulp-md-template 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 1.1.4                                ...           latest (2 years ago)

5 Versions

  • 1.1.4                                ...           2 years ago
  • 1.1.2                                ...           5 years ago
  • 1.1.1                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (3)
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |