https://github.com/adebola-io/siphon

Web bundler for front-end applications. 📦🗜
https://github.com/adebola-io/siphon

bundle bundler cli compilers css html html-css-javascript javascript minify nodejs npm typescript

Last synced: 2 months ago
JSON representation

Web bundler for front-end applications. 📦🗜

• Host: GitHub
• URL: https://github.com/adebola-io/siphon
• Owner: adebola-io
• License: isc
• Created: 2022-03-30T15:19:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-21T07:16:19.000Z (over 2 years ago)
• Last Synced: 2024-11-07T16:55:01.543Z (2 months ago)
• Topics: bundle, bundler, cli, compilers, css, html, html-css-javascript, javascript, minify, nodejs, npm, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/siphon-cli
• Size: 1.6 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
 Siphon 

  


  

    

  

  

    

  

  

    

  

  


**Siphon is still in an early stage of development.**

## Overview

Siphon is a simple web bundler that reads HTML documents and resolves their assets into fewer files for production.

---

## Quick Start

To get started, install Siphon with the node command:

```shell

npm install -g siphon-cli

```

Once it is installed, you can cd into a project folder with an `index.html` file and run the command:

```shell

siphon-cli -bundle index.html

```

This command will read the file, determine all its required assets, and bundle them up into an `index.html` file in a `build` folder.

---

## Watch Mode

Running Siphon in watch mode will set it to automatically bundle up your project whenever changes are made to the base file or its assets.

**By default, Siphon assumes your base file is src/index.html, and all your assets are stored in the src folder.**

To run Siphon in watch mode, cd to the root of your project and run the command:

```shell

siphon-cli -bundle --w

```

---

## Configuration

You can reconfigure the behavior of the bundler by including a `siphon.config.js` file in the root of your project.

For example, to change the output directory, create the config file and add:

```js

module.exports = {

  outDir: "./dist",

};

```

When the bundler is run, it will bundle files into a `dist` folder, rather than the default `build`.

For more on configuration, see [Siphon Configs](https://github.com/adebola-xyz/siphon/blob/master/docs/CONFIG.md).