📦 PortaPack

PortaPack bundles your entire website — HTML, CSS, JS, images, and fonts — into one self-contained HTML file. Perfect for snapshots, demos, testing, and offline apps.

Minimal input. Maximal output.

📚 Documentation

• 📖 Getting Started
• ⚙️ CLI Reference
• 🛠 Configuration Guide
• 💻 API Reference
• 🤝 Contributing Guidelines

🚀 Quick Start

📦 Install

# Global CLI (recommended)
npm install -g portapack

# OR use npx (no install needed)
npx portapack ./index.html -o bundle.html

🧰 CLI Options

portapack [input] [options]

Option	Description
-o, --output <file>	Output file path
-r, --recursive [n]	Crawl site up to n levels deep
--max-depth <n>	Explicit crawl depth
-m, --minify	Enable all minification
--no-minify-*	Disable html, css, or js minify
-e, --embed-assets	Inline all assets (default: true)
--no-embed-assets	Leave links as-is
-b, --base-url <url>	Override base URL resolution
-v, --verbose	Show debug output
--log-level <lvl>	Set log level: debug, info, warn, error
-d, --dry-run	Run without writing file

📋 CLI Examples

# Basic
portapack ./index.html
portapack https://example.com

# With output path
portapack ./page.html -o dist/output.html

# Full recursive bundle
portapack https://example.com --recursive 2 -o full.html

# Dev mode (no minify, verbose)
portapack ./src/index.html --no-minify -v

# Production mode (optimized)
portapack ./src/index.html -m -o dist/prod.html

# Dry run preview
portapack ./index.html --dry-run

📦 Node.js API

PortaPack is fully usable via code.

Simple Usage

import { pack } from 'portapack';

const result = await pack('./index.html'); // local or URL
console.log(result.html); // bundled HTML

With Options

import { pack, LogLevel } from 'portapack';

const result = await pack('https://example.com', {
  minifyCss: true,
  minifyJs: false,
  recursive: 2,
  output: 'site.html',
  logLevel: LogLevel.INFO
});

Save to Disk

import fs from 'fs';
fs.writeFileSync('output.html', result.html);

Advanced API Usage

You can access individual building blocks too:

import {
  generatePortableHTML,
  generateRecursivePortableHTML,
  bundleMultiPageHTML,
  fetchAndPackWebPage,
} from 'portapack';

Function	Purpose
generatePortableHTML()	Bundle a single file or URL
generateRecursivePortableHTML()	Crawl & bundle entire site
fetchAndPackWebPage()	Just fetch HTML (no asset processing)
bundleMultiPageHTML()	Combine multiple HTMLs with router

🧪 Use Cases

• Archive pages for offline use
• Create demo bundles without a web server
• Simplify distribution of small apps
• QA test static assets
• Embed pages in PDFs or ebooks
• Analyze asset weight impact

🤝 Contribute

# Get started
git clone https://github.com/manicinc/portapack
cd portapack
npm install
npm run dev

📊 Project Health

(Metrics auto-generated coming soon)

📄 License

MIT — Built with ✨ by Manic Agency

Open Source Empowering Designers and Developers 🖥️