https://github.com/evocode/metalsmith-base

A base starter for metalsmith project
https://github.com/evocode/metalsmith-base

Last synced: about 2 months ago
JSON representation

A base starter for metalsmith project

• Host: GitHub
• URL: https://github.com/evocode/metalsmith-base
• Owner: evocode
• License: mit
• Created: 2015-11-02T23:16:49.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-19T11:23:29.000Z (almost 9 years ago)
• Last Synced: 2024-08-03T22:03:43.196Z (5 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 122
• Watchers: 5
• Forks: 22
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-metalsmith - Metalsmith-base

README

        
# Metalsmith Base

A metalsmith base starter kit used at [Evocode.com](http://evocode.com/). Some features:

- [Metalsmith](http://metalsmith.io/)

- [Gulp](http://gulpjs.com/)

- [Bootstrap 4](https://github.com/twbs/bootstrap/tree/v4-dev)

- [jQuery](https://github.com/jquery/jquery)

- [Babel / ES6](https://babeljs.io/)

- [Development Server](https://github.com/evocode/metalsmith-base/blob/master/gulpfile.js#L160)

- [Static Site, Blog, Robots, Sitemap](https://github.com/evocode/metalsmith-base/tree/master/content)

- [MIT license](https://github.com/evocode/metalsmith-base/blob/master/LICENSE)

## Install

```

mkdir newproject

git clone [email protected]: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 "[email protected]:username/repository.git" > .buildrepo`

1. Edit `package.json` script section: `"build": "./node_modules/.bin/gulp --production --build && ./build.sh [email protected]:username/repository.git"`

After the repository is setup, simply run:

```

npm run build

```

## Commands

1. `npm run dev` - Run a development build

1. `npm run start` - Run a development build, start the development server and watchers

1. `npm run debug` - Run a development build in debug mode

1. `npm run production` - Run a production build, compiles assets and minifies

1. `npm run build` - Run a production build and sync with git

1. `npm run watch` - Start the gulp watchers

1. `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`