A base starter for metalsmith project
JavaScript HTML CSS Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Metalsmith Base

A metalsmith base starter kit used at Evocode.com. Some features:

Install

mkdir newproject
git clone git@github.com:evocode/metalsmith-base.git newproject
cd newproject
npm install

Develop

This command will fully build a development version of the site, start the gulp watchers, and setup a development server. The command output will list the server address to open in your browser.

npm run start

Build

This command will build a production version of the site and sync it with a git repository, ready to be comitted.

To link the build process to your repository, you can do of the following options:

  1. Create a repo dotfile: echo "git@github.com:username/repository.git" > .buildrepo
  2. Edit package.json script section: "build": "./node_modules/.bin/gulp --production --build && ./build.sh git@github.com:username/repository.git"

After the repository is setup, simply run:

npm run build

Commands

  1. npm run dev - Run a development build
  2. npm run start - Run a development build, start the development server and watchers
  3. npm run debug - Run a development build in debug mode
  4. npm run production - Run a production build, compiles assets and minifies
  5. npm run build - Run a production build and sync with git
  6. npm run watch - Start the gulp watchers
  7. npm run vendor - Copies over any vendor files from node_modules to metalsmith assets

All commands can be run directly with: ./node_modules/.bin/gulp