minimalist-pugjs-boilerplate v1.0.0

MONK BOILERPLATE

My name is MONK and this is a minimalist boilerplate, why MONKS says 'LESS IS MORE'

This is a minimalist pug.js boilerplate based on Start Bootstrap Creative Theme.

Download and Installation

To begin using this template, choose one of the following options to get started:

• Fork, Clone, or Download on GitHub
• Clone the repo: git clone https://github.com/domenicomonaco/minimalist-pugJS-boilerplate.git
• Install using npm: npm i

Usage

Basic Usage

After downloading, simply edit the HTML and CSS files included with dist directory. These are the only files you need to worry about, you can ignore everything else! To preview the changes you make to the code, you can open the index.html file in your web browser.

Advanced Usage

Clone the source files of the theme and navigate into the theme's root directory. Run npm install and then run npm start which will open up a preview of the template in your default browser, watch for changes to core template files, and live reload the browser when changes are saved. You can view the package.json file to see which scripts are included.

npm Scripts

• npm run build builds the project - this builds assets, HTML, JS, and CSS into dist
• npm run build:static copies the files in the src/static/ directory into dist
• npm run build:assets copies the files in the src/assets/ directory into dist
• npm run build:pug compiles the Pug located in the src/pug/ directory into dist
• npm run build:scripts brings the src/js/scripts.js file into dist
• npm run build:scss compiles the SCSS files located in the src/scss/ directory into dist
• npm run clean deletes the dist directory to prepare for rebuilding the project
• npm run start:debug runs the project in debug mode
• npm start or npm run start runs the project, launches a live preview in your default browser, and watches for changes made to files in src

You must have npm installed in order to use this build environment.

About

MONK Boilerplate is an open source starter kit based on the Bootstrap framework and Pug high-performance template engineimplemented with JavaScript previouse formerly known as "Jade"

Copyright and License

Copyright 2021-2022 Domenico Monaco https://domenicomonaco.it Code released under the MIT license.

As the previous Fork

Copyright 2013-2021 Start Bootstrap LLC. Code released under the MIT license.