Static Blog Generator (NodeJS, Gulp, Nunjucks, Markdown)
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
themes
.gitignore
LICENSE
README.md
_config.example.json
gulpfile.js
package-lock.json
package.json

README.md

Static Site Generator

Markdown based static blog generator. Uses for: https://antonfisher.com

Features

  • Static HTML generation (Index, Posts, About pages)
  • Markdown for posts
  • Nunjucks Templates for theming
  • Gulp based
  • RSS feed generator.

Usage

  • Create blog folder: $ mkdir myblog && cd myblog
  • Create .gitignore file: $ echo 'static-site-generator'>.gitignore
  • Clone generator: $ git clone https://github.com/antonfisher/static-blog-generator.git
  • Copy config file: $ cp static-blog-generator/_config.example.json _config.json
  • Configure: $ vim _config.json
  • Go to generator folder: $ cd static-blog-generator
  • Install dependencies $ npm install
  • Run generator $ npm start or $ ./node_modules/.bin/gulp.

Configuration

File _config.json:

{
  "theme": "default",
  "name": "{NAME}",
  "email": "{EMAIL}",
  "url": "{SITE}.com",
  "rssUUID": "{RSS-UUID}",
  "description": "{DEFAULT META DESCRIPTION}"
}

Release History

  • 1.0.0 Initial release
    • Gulp tasks
    • HTML generator
    • About page
    • RSS feed generator
    • Config file
    • Themes

ToDo

  • Config example
  • Themes images
  • Copy all theme files
  • Post summary on index page
  • GA config
  • Host in config
  • Generate meta
  • Comments
  • Sitemap
  • Tags support
  • Pagination
  • Update default theme
  • Check same posts links
  • 404 page

License

Copyright (c) 2015 Anton Fisher a.fschr@gmail.com

MIT License. Free use and change.