Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webdiscus/webpack-html-scss-boilerplate
Webpack boilerplate for multipage sites using Nunjucks, HTML, SCSS, JS
https://github.com/webdiscus/webpack-html-scss-boilerplate
boilerplate html inline-svg js multipage nunjucks plugin sass scss starter template webpack
Last synced: 1 day ago
JSON representation
Webpack boilerplate for multipage sites using Nunjucks, HTML, SCSS, JS
- Host: GitHub
- URL: https://github.com/webdiscus/webpack-html-scss-boilerplate
- Owner: webdiscus
- License: isc
- Created: 2023-01-16T13:58:35.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-30T22:56:06.000Z (9 months ago)
- Last Synced: 2024-09-22T12:31:04.857Z (5 days ago)
- Topics: boilerplate, html, inline-svg, js, multipage, nunjucks, plugin, sass, scss, starter, template, webpack
- Language: SCSS
- Homepage: https://webdiscus.github.io/webpack-html-scss-boilerplate/index.html
- Size: 9.17 MB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Webpack boilerplate
A simple multipage Webpack boilerplate using HTML, SCSS, JS.
See the [demo site](https://webdiscus.github.io/webpack-html-scss-boilerplate/index.html).
## Installation
```
git clone https://github.com/webdiscus/webpack-html-scss-boilerplate.git
cd webpack-html-scss-boilerplate
npm i
```
## Usage
### Start local development
```
npm start
```
### Build production files
```
npm run build
```
### Preview the production in browser
```
npm run preview
```
## How it works
To build static pages is used the powerful [html-bundler-webpack-plugin](https://github.com/webdiscus/html-bundler-webpack-plugin).
Add the new HTML page in the `entry` option:
```js
const HtmlBundlerPlugin = require('html-bundler-webpack-plugin');
module.exports = {
plugins: [
new HtmlBundlerPlugin({
entry: {
// define HTML files here
'index': './src/views/home/index.html', // output dist/index.html
'route/to/page': './src/views/page/index.html', // output dist/route/to/page.html
},
}),
],
// ...
};
```
> **Note**
>
> Using the `html-bundler-webpack-plugin` the entrypoint is an HTML file.\
> All source files of styles, scripts, images can be loaded directly in HTML.\
> This Plugin automatically extracts all used source resources into separate output file.
Add source files of styles, scripts, images directly in HTML:
```html
Homepage
```
Specify output filenames of script and styles using `js` and `css` options of the Plugin:
```js
const HtmlBundlerPlugin = require('html-bundler-webpack-plugin');
module.exports = {
plugins: [
new HtmlBundlerPlugin({
// path to directory with templates
entry: 'src/views/home/',
// or define templates manually
entry: {
'index': './src/views/home/index.html', // output dist/index.html
'route/to/page': './src/views/page/index.html', // output dist/route/to/page.html
},
js: {
// output filename of extracted JS from source script loaded in HTML via `` tag
filename: 'assets/js/[name].[contenthash:8].js', // output into dist/assets/js/ directory
},
css: {
// output filename of extracted CSS from source style loaded in HTML via `<link>` tag
filename: 'assets/css/[name].[contenthash:8].css', // output into dist/assets/css/ directory
},
}),
],
// ...
};
```
To extract images form HTML into separate files add the simple rule to Webpack config:
```js
module.exports = {
module: {
rules: [
{
test: /[\\/]images[\\/].+(png|jpe?g|svg|webp|ico)$/i, // load images from `images` directory only
generator: {
// output filename of extracted image
filename: 'assets/img/[name].[hash:8][ext]', // output into dist/assets/img/ directory
},
},
],
},
// ...
};
```
To extract images into separate files or `inline images` add the advanced rule to Webpack config:
```js
module.exports = {
module: {
rules: [
{
test: /[\\/]images[\\/].+(png|jpe?g|svg|webp|ico)$/i, // load images from `images` directory only
oneOf: [
// inline image using `?inline` query
{
resourceQuery: /inline/,
type: 'asset/inline',
},
// auto inline by image size
{
type: 'asset',
parser: {
dataUrlCondition: {
maxSize: 1024,
},
},
generator: {
// output filename of extracted image
filename: 'assets/img/[name].[hash:8][ext]', // output into dist/assets/img/ directory
},
},
],
},
],
},
// ...
};
```
> **Note**
>
> Add the `[\\/]images[\\/]` to the `test` RegExp when you have `SVG` files for fonts and images to restrict this rule to images only.
## Also See
- [ansis][ansis] - The Node.js library for ANSI color styling of text in terminal.
- [pug-plugin][pug-plugin] - Webpack plugin for Pug.
- [pug-loader][pug-loader] - Webpack loader for Pug.
## License
[ISC](https://github.com/webdiscus/html-bundler-webpack-plugin/blob/master/LICENSE)
[ansis]: https://github.com/webdiscus/ansis
[pug-plugin]: https://github.com/webdiscus/pug-plugin
[pug-loader]: https://github.com/webdiscus/pug-loader