Getting Started
Start building static HTML pages the peaceful, minimalist way.
📦 Installation
Get started in seconds. Use it via npx for one-time builds, or install globally for regular
use:
Quick Start
npx @fwdslsh/unify build
Global Install
npm install -g @fwdslsh/unify
🏗️ Project Setup
Create your project structure with includes for shared components:
📁 Recommended Structure
src/
├── index.html
├── about.html
├── _includes/
│ ├── head.html ← Global styles & meta
│ ├── header.html ← Navigation
│ └── footer.html ← Footer content
└── css/
└── main.css ← Your styles
Build your site with a single command:
$ unify build --source src --output dist
Your site will be generated in dist/ with all includes resolved and head content injected.
🚀 Development Server
Start a local development server with live reload for rapid iteration:
$ unify serve --source src --output dist --port 3000
✨ Live Development Features
- 🔄 Hot reload on file changes
- 📊 Dependency tracking rebuilds only what changed
- 🎯 Selective updates for faster iteration
- 📱 Works on all devices via local network, great for mobile testing
⚙️ Advanced Options
🔍 Dry Run
--dry-run
Preview changes without writing files
📝 Verbose
--verbose
Detailed processing and dependency info
📂 Custom Paths
--head custom.html
Override default head injection file
💡 Philosophy
🌊 The Flow of Simplicity
No frameworks. No bundlers. No complexity.
Just HTML includes, head injection, and the peaceful satisfaction of building something that works exactly as expected.