https://github.com/josephdavis/gulp-flat-blog

A flat-file blog generator for gulp. Builds html posts from markdown files.
https://github.com/josephdavis/gulp-flat-blog

blog blogging gulp highlighting

Last synced: 13 days ago
JSON representation

A flat-file blog generator for gulp. Builds html posts from markdown files.

• Host: GitHub
• URL: https://github.com/josephdavis/gulp-flat-blog
• Owner: JosephDavis
• License: mit
• Created: 2015-05-30T11:47:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-23T18:42:59.000Z (about 7 years ago)
• Last Synced: 2025-01-30T08:33:40.689Z (14 days ago)
• Topics: blog, blogging, gulp, highlighting
• Language: JavaScript
• Homepage:
• Size: 28.3 KB
• Stars: 4
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gulp Flat Blog

A flat file blog generator gulp plugin. Builds html posts from markdown files.

### Features

- Front-matter

- Markdown (via markdown-it)

- Static Code Highlighting (via Highlight.js)

- Template-engine independent (any function works as a template)

### Easy to use:

Simply pass in a `single` and `index` template in a config object.

```javascript

var fs = require('fs');

var gulp = require('gulp');

var handlebars = require('handlebars');

var gulpFlatBlog = require('gulp-flat-blog');

gulp.task('default', function() {

  return gulp.src('posts/*.md')

    .pipe(gulpFlatBlog({

      single: handlebars.compile(fs.readFileSync('single.hbs', 'utf8')),

      index: handlebars.compile(fs.readFileSync('index.hbs', 'utf8'))

    }))

    .pipe(gulp.dest('public'));

});

```

### Installation

```

npm install gulp-flat-blog

```