generator-metalsmith-project v1.0.1

generator-metalsmith-project

Yeoman Generator for Metalsmith projects 🚀

Requirements

• Node 8.x
• eslint

Features

• Bootstrap 4 (beta)
• jQuery 3
• ES6+ Ready
• Browsersync for local development

Usage

npm i -g yo

Install Yeoman globally if you haven't done so already.

npm i -g generator-metalsmith-project

Install this generator globally.

yo metalsmith-project

Navigate to your project's directory via Terminal and run yo metalsmith-project to provision your new project. Once completed, you can begin working on the project with the use of a simple npm script.

npm start

Local development command, serving ./public via Browsersync. Gulp Watch will build the Metalsmith site, transpile JavaScript via Babel and Browserify and compile Sass to CSS.

License

The MIT License (MIT)

Copyright (c) 2016 John Foderaro

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.