blog-maker

Blog generator from .md post files, highly inspired from blog.nodejs.org

npm install blog-maker
6 downloads in the last week
15 downloads in the last month

blog-maker -- generate blog from .md files, highly inspired by blog.nodejs.org

Description

This blog generator is highly inspired by blog.nodejs.org (meaning, I've extracted the code which make it works from https://github.com/joyent/node to make it work as a stand alone module =) )

Big props to @dshaw for giving me this idea and @isaacs for explaining me how the magic was done =)

Install

  npm install blog-maker

How to use

To generate a simple blog, you will need:

  • A folder where you insert the blog posts as .md files
  • An rss.xml template to generate the blog feed
  • An .html file to use as template for each blog post

You can find examples of this in the 'data' folder of this repo

To use it, just require the module

var blogMaker = require('blog-maker');

And then call the function returned with the following args:

  • - for example data/posts
  • - output folder
  • - for example data/blog.html
  • - for example data/rss.xml
  • [blogPath] - if you want your blog to be hosted in yourdomain.com/blog, pass 'blog' in this arg
  • [numberOfPostPerPage] - number of posts presented per page

example:

blogMaker('data/posts', 'public', 'data/blog.html', 'data/rss.xml')

You can find and example using node-static to server the blog posts in the 'example' folder, to try it, just run node example/example_run.js

A blog contributors guide template

Structure

data/posts - Folder containing all the posts

data/blog.html - blog page template (for each post)

data/rss.xml - rss feed template

Adding a new post

  1. Open data/posts folder
  2. Create a new
npm loves you