# @videinfra/static-website-builder

> Customizable static site project builder

Latest version **2.5.1** (published 2026-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @videinfra/static-website-builder
pnpm add @videinfra/static-website-builder
yarn add @videinfra/static-website-builder
bun add @videinfra/static-website-builder
```

Provides the command `builder`.

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.5.1 |
| Published | 2026-09-01 |
| First published | 2020-06-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.0.0 |
| Dependencies | 32 |
| Unpacked size | 269.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Vide Infra |
| Maintainers | eugenekharkov, kasparsz |

## Links

- npm: https://www.npmjs.com/package/@videinfra/static-website-builder
- Repository: https://github.com/videinfra/static-website-builder
- Homepage: https://github.com/videinfra/static-website-builder#readme
- Issues: https://github.com/videinfra/static-website-builder/issues
- npm.io page: https://npm.io/package/@videinfra/static-website-builder

## Dependencies (32)

- [del](https://npm.io/package/del.md) ^8.0.1
- [gulp](https://npm.io/package/gulp.md) ^5.0.1
- [svgo](https://npm.io/package/svgo.md) ^4.0.1
- [twig](https://npm.io/package/twig.md) ^1.17.1
- [chalk](https://npm.io/package/chalk.md) 5.6.2
- [dotenv](https://npm.io/package/dotenv.md) ^17.3.1
- [cssnano](https://npm.io/package/cssnano.md) ^7.1.2
- [gulp-if](https://npm.io/package/gulp-if.md) ^3.0.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.1
- [through](https://npm.io/package/through.md) ^2.3.8
- [chokidar](https://npm.io/package/chokidar.md) ^5.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.8
- [rolldown](https://npm.io/package/rolldown.md) ^1.0.2
- [cross-env](https://npm.io/package/cross-env.md) ^10.1.0
- [gulp-data](https://npm.io/package/gulp-data.md) ^1.3.1
- [gulp-cached](https://npm.io/package/gulp-cached.md) ^1.1.1
- [gulp-ignore](https://npm.io/package/gulp-ignore.md) ^3.0.0
- [lodash.some](https://npm.io/package/lodash.some.md) ^4.2.2
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^10.4.27
- [browser-sync](https://npm.io/package/browser-sync.md) ^3.0.4
- [gulp-htmlmin](https://npm.io/package/gulp-htmlmin.md) ^5.0.1
- [gulp-plumber](https://npm.io/package/gulp-plumber.md) ^1.2.1
- [gulp-postcss](https://npm.io/package/gulp-postcss.md) ^10.0.0
- [gulp-sitemap](https://npm.io/package/gulp-sitemap.md) ^8.0.0
- [lodash.clone](https://npm.io/package/lodash.clone.md) ^4.3.2
- [nano-memoize](https://npm.io/package/nano-memoize.md) 3.0.16
- [gulp-svgstore](https://npm.io/package/gulp-svgstore.md) ^9.0.0
- [sass-embedded](https://npm.io/package/sass-embedded.md) ^1.97.3
- [gulp-dependents](https://npm.io/package/gulp-dependents.md) ^1.2.5
- [gulp-sizereport](https://npm.io/package/gulp-sizereport.md) ^1.2.1
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^3.0.0
- [@csstools/postcss-nested-calc](https://npm.io/package/@csstools/postcss-nested-calc.md) ^5.0.0

## Recent versions

- 2.5.1 (latest) — 2026-09-01
- 2.0.0-beta.4 (develop) — 2026-01-29
- 2.5.0 — 2026-05-21
- 2.4.6 — 2026-05-20
- 2.4.5 — 2026-05-18
- 2.4.4 — 2026-05-18
- 2.4.3 — 2026-04-30
- 2.4.2 — 2026-04-23
- 2.4.1 — 2026-04-23
- 2.4.0 — 2026-04-23
- 2.3.2 — 2026-04-13
- 2.3.1 — 2026-04-09
- 2.3.0 — 2026-04-09
- 2.2.2 — 2026-04-08
- 2.2.1 — 2026-03-12
- … 79 more at https://npm.io/package/@videinfra/static-website-builder/versions

## README

[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
[travis-url]: https://travis-ci.org/videinfra/static-website-builder
[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

`static-website-builder` is a customizable static site project builder powered by Gulp, Rolldown, SASS, PostCSS, TwigJS, BrowserSync

## Requirements

- Node.js >= 20.0.0

## Features

- Gulp: built using gulp
- Built-in Server: Local development server with hot reloading
- Templates: HTML templates with minification
- TWIG: Optional TwigJS template engine with optional plugins for additional functions and filters
- Stylesheets: Autoprefixing and minification with PostCSS support 
- SASS: Optional SASS / SCSS compilation
- Javascript/Typescript: Transpilation, bundling and minification with rolldown
- SVG icons: Sprite generation from individual SVG files


* Paths: Source and destinations paths are configurable
* Features: All features can be configured or disabled
* Plugins: create additional plugins / gulp tasks

## Quick start

```
npm init
npm install @videinfra/static-website-builder --save
npx builder init
```

Start development server
```
npm run start
```

Build production files
```
npm run start
```

Note: these commands are added to the project during `npm init`.

## Commands

### Development server

```npx run builder watch```

### Generate production ready files

```npx run builder build```

### List all available tasks

```npx run builder --tasks```

## Project templates

As used in quick start, project templates are used to generate boilerplate / starter files and add commands to the project:

- [`default`](https://github.com/videinfra/static-website-builder/tree/master/init/default) - simple template with normalize.scss


## Plugins

Built-in plugins:
- `sass` - adds `.sass` and `.scss` file rendering using SASS
- `twig` - adds `.twig` file rendering using TwigJS
- `twig/symfony-filters` - adds `humanize` filter as found in Symfony
- `twig/symfony-functions` - adds `asset` function as found in Symfony
- `twig/lodash-filters` - adds `omit`, `pick`, `filter`, `reject` and `find` filters as in lodash

Plugins can be enabled by adding them to the `config/config.js`, eg.

```js
export const plugins = [
    // Enables SASS engine and .sass and .scss file compilation
    require('@videinfra/static-website-builder/plugins/sass'),

    // Enables TwigJS engine .twig file compilation
    require('@videinfra/static-website-builder/plugins/twig'),
    require('@videinfra/static-website-builder/plugins/twig/symfony-filters'),
    require('@videinfra/static-website-builder/plugins/twig/symfony-functions'),
    require('@videinfra/static-website-builder/plugins/twig/lodash-filters'),
];
```

## Wiki

See [our wiki](https://github.com/videinfra/static-website-builder/wiki) for additional information.

[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
[travis-url]: https://travis-ci.org/videinfra/static-website-builder
[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master

---
_Source: https://npm.io/package/@videinfra/static-website-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
