0.0.1 • Published 7 years ago

genie-cli v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

Genie

Custom built static site generator currently in use at harrisjose.github.io

  • Written for Node v8.7+
  • Uses handlebars for templating and markdown for content
  • Latest ES version support and minification with Babel
  • Autoprefixer and other css transforms using PostCSS

Usage

Folder Structure

- Root/
  - templates/
  - partials/
  - content/
    - blog/
      - post.md
    - about.md
    - index.html
  - assets/
    - css/
      - site.css
    - js/
      - index.js
    - images/

Configuration

Configuration from a genie.js file in your projects root folder is used if it exists. Genie should also work with defaults if no configuration file is found.

/* genie.js */
{
  paths: {
    content: 'path/to/content',
    output: 'path/to/site',
    templates: 'path/to/templates',
    partials: 'path/to/partials',
    helpers: 'path/to/helpers'
  },
  data: {
    prop: 'Gobal data props',
  },
  postcss: {
    'postcss-plugin': { plugin-options }
  },
  babel: { config }
}

About

Why?

Because, this.

TODO

Support for inlining source files
Allow using a different config file for production builds.

JavaScript Style Guide