GitXplorerGitXplorer
d

blog-maker

public
8 stars
1 forks
3 issues

Commits

List of commits on branch master.
Unverified
9a462a1f068f9194729cb82348f25122130f3546

bump version

ddaviddias committed 10 years ago
Unverified
a1d0e288b7ea983c7a069e7a25ab9ca4b639e89c

add requiresafe to the precommit hooks

ddaviddias committed 10 years ago
Unverified
c4a040ad1ad89f467067f97ea9b30a0c9629573e

changed github repo username

ddaviddias committed 11 years ago
Unverified
86d4cee90147efeea7b735a782efd93d620ebe06

changed github repo username

ddaviddias committed 11 years ago
Unverified
74080a2c34166d60d88d737918d01e998a6f1001

bumped the version

ddaviddias committed 12 years ago
Unverified
4d3eb57894766d463b1a92574d4a842192164c03

Changed generate function to accept argument object, to simplify access to optional arguments.

nnunofmn committed 12 years ago

README

The README file for this repository.

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 <title of post>.md file
  3. Add title, author, date, slug and category, e.g:
  • title: Best post in the world
  • author: Alice
  • date: Fri Jan 12 00:45:13 UTC 2012
  • slug: megapost
  • category: postland
  1. Write your post (use html you want) <blockquote></blockquote> <code></code> You name it :)

  2. Then you just have to run blog-maker

Note: folder hierarchy in data/posts is meaningless, you can use it for your own organization, for example, one folder for each author or for each category

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.