This is a lightweight framework used to create and compile your site
Latest docs accesible only in russian README.RU.md
gulp-include) as fallback
src ├── package.json ├── bower.json ├── index.js ├── lib/ ├── routes/ ├── public/ │ ├── js/ │ │ ├── includes/ │ │ ├── partials/ │ │ └── views/ │ ├── css/ │ │ ├── includes/ │ │ ├── partials/ │ │ └── views/ │ ├── font/ │ └── img/ └── views/ ├── partials/ └── templates/
File with npm deps
File with bower deps
Main file of your Nodejs project. This script will be called by nodemon when you run
If you're making a static site, you won't need this file.
This folder should be used for scripts which define the routes for you site
This folder will be routed as '/public' with Browsersync, or, in case you use your own server, you must make this folder accesible as
It'll be a good practice if you'll use those files as the main scripts/styles for your site
Also it would be very nice if you'll use this files for some of your routes, for example
views/index.css -> / views/about.css -> /about
const $ = require('jquery') // If you use Browserify //=require includes/somefile.js // If you use fallback `gulp-include`
Example of CSS including:
@import 'includes/somefile'; /* This import in your css includes/_somefile.css */
This folder is very similar to includes/, but it would be nice if you'll use this folder for some widgets of your site, and it's recommended to include this files only in the main files (and not in the views/* files)
This is the folder for your views of the site, if you use your own server
If youre creating a static site - put your Pug or HTML there, and the files will be routed as
/. For example
views/index.pug -> /index.html views/about.html -> /about.html
First you need create the file structure described previous (if you use Yeoman generator, you can skip this step)
cp -Rp example/ src/
Create a sample config (if you use Yeoman generator, skip this step)
cp config.example.json config.json vim config.json
Now you can execute
gulp in order to start the build, watching and live-reload your code. Or you can simply run
gulp build or
gulp server separately. Also you can run
gulp lint for linting,
gulp fix for fixing and beautifing the code and
gulp self-update for updating this script.
--all flag enables the building of all the files, without changing none of them.
--production flag enables the production mode.
--deploy flag enables deploying using rsync.
MIT © Grigorii Horos