portapack 0.3.1 → 0.3.3

package/docs/.vitepress/config.ts

@@ -1,5 +1,5 @@
-import { defineConfig } from 'vitepress'
-import { buildDocsSidebar } from './sidebar-generator'
+import { defineConfig } from 'vitepress';
+import { buildDocsSidebar } from './sidebar-generator';
 
 export default defineConfig({
   base: '/portapack/',
@@ -7,48 +7,53 @@ export default defineConfig({
   description: 'Bundle & Minify HTML into a Single Portable File',
   appearance: 'dark',
   lastUpdated: true,
-  
+
   head: [
-    ['link', { rel: 'icon', href: '/favicon.png' }],
+    ['link', { rel: 'icon', href: '/portapack/favicon.ico' }],
     ['meta', { name: 'og:title', content: 'PortaPack' }],
-    ['meta', { name: 'og:description', content: 'Bundle & Minify HTML into a Single Portable File' }],
-    ['meta', { name: 'og:image', content: '/og-image.png' }],
-    ['meta', { name: 'twitter:card', content: 'summary_large_image' }]
+    [
+      'meta',
+      { name: 'og:description', content: 'Bundle & Minify HTML into a Single Portable File' },
+    ],
+    ['meta', { name: 'og:image', content: '/portapack/portapack.jpg' }], // Updated to use your non-transparent logo
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
   ],
 
   themeConfig: {
-    logo: '/logo.png',
-    
+    logo: '/portapack-transparent.png', // This path is relative to the public directory
+
     socialLinks: [
       { icon: 'github', link: 'https://github.com/manicinc/portapack' },
       { icon: 'twitter', link: 'https://x.com/manicagency' },
       { icon: 'discord', link: 'https://discord.gg/DzNgXdYm' },
-      { 
+      {
         icon: {
-          svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 0h-14c-2.761 0-5 2.239-5 5v14c0 2.761 2.239 5 5 5h14c2.762 0 5-2.239 5-5v-14c0-2.761-2.238-5-5-5zm-11 19h-3v-11h3v11zm-1.5-12.268c-.966 0-1.75-.79-1.75-1.764s.784-1.764 1.75-1.764 1.75.79 1.75 1.764-.783 1.764-1.75 1.764zm13.5 12.268h-3v-5.604c0-3.368-4-3.113-4 0v5.604h-3v-11h3v1.765c1.396-2.586 7-2.777 7 2.476v6.759z"/></svg>'
-        }, 
-        link: 'https://www.linkedin.com/company/manic-agency-llc/' 
-      }
+          svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 0h-14c-2.761 0-5 2.239-5 5v14c0 2.761 2.239 5 5 5h14c2.762 0 5-2.239 5-5v-14c0-2.761-2.238-5-5-5zm-11 19h-3v-11h3v11zm-1.5-12.268c-.966 0-1.75-.79-1.75-1.764s.784-1.764 1.75-1.764 1.75.79 1.75 1.764-.783 1.764-1.75 1.764zm13.5 12.268h-3v-5.604c0-3.368-4-3.113-4 0v5.604h-3v-11h3v1.765c1.396-2.586 7-2.777 7 2.476v6.759z"/></svg>',
+        },
+        link: 'https://www.linkedin.com/company/manic-agency-llc/',
+      },
     ],
 
     footer: {
       message: 'Released under the MIT License',
-      copyright: '© 2025 Manic Agency. All rights reserved.'
+      copyright: '© 2025 Manic Agency. All rights reserved.',
     },
 
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Getting Started', link: '/getting-started' },
-      { 
-        text: 'Docs', 
+      {
+        text: 'Docs',
         items: [
           { text: 'CLI Reference', link: '/cli' },
           { text: 'API', link: '/api/README' },
           { text: 'Configuration', link: '/configuration' },
-          { text: 'Advanced Usage', link: '/advanced' }
-        ]
+          { text: 'Advanced Usage', link: '/advanced' },
+        ],
       },
-      { text: 'Contributing', link: '/contributing' }
+      { text: 'Contributing', link: '/contributing' },
+      { text: 'Architecture', link: '/architecture'},
+      { text: 'Roadmap', link: 'roadmap'}
     ],
 
     sidebar: {
@@ -59,9 +64,9 @@ export default defineConfig({
           items: [
             { text: 'Introduction', link: '/getting-started/' },
             { text: 'Installation', link: '/getting-started/installation' },
-            { text: 'Quick Start', link: '/getting-started/quick-start' }
-          ]
-        }
+            { text: 'Quick Start', link: '/getting-started/quick-start' },
+          ],
+        },
       ],
       '/cli/': [
         {
@@ -69,9 +74,9 @@ export default defineConfig({
           items: [
             { text: 'Overview', link: '/cli/' },
             { text: 'Commands', link: '/cli/commands' },
-            { text: 'Options', link: '/cli/options' }
-          ]
-        }
+            { text: 'Options', link: '/cli/options' },
+          ],
+        },
       ],
       '/configuration/': [
         {
@@ -79,10 +84,10 @@ export default defineConfig({
           items: [
             { text: 'Overview', link: '/configuration/' },
             { text: 'Options', link: '/configuration/options' },
-            { text: 'Advanced', link: '/configuration/advanced' }
-          ]
-        }
-      ]
-    }
-  }
-})
+            { text: 'Advanced', link: '/configuration/advanced' },
+          ],
+        },
+      ],
+    },
+  },
+});

package/docs/.vitepress/sidebar-generator.ts

@@ -1,5 +1,6 @@
-import { glob } from 'glob'
-import path from 'path'
+import { glob } from 'glob';
+import path from 'path';
+import { fileURLToPath } from 'url'; // Needed for ESM __dirname equivalent
 
 /**
  * Sidebar item interface for VitePress configuration
@@ -11,63 +12,113 @@ export interface SidebarItem {
   collapsed?: boolean;
 }
 
+// --- Helper to get the directory name in ES Modules ---
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+// --- Assuming sidebar-generator.ts is directly inside 'docs' ---
+// If it's deeper, adjust accordingly (e.g., path.resolve(__dirname, '..'))
+const docsDir = __dirname;
+const apiDir = path.join(docsDir, 'api'); // Absolute path to the api directory
+
 /**
  * Automatically builds sidebar from generated TypeDoc files
  * @returns Dynamically generated sidebar configuration
  */
 export function buildDocsSidebar(): SidebarItem[] {
   try {
+    // Log the directory being scanned
+    console.log(`Scanning for markdown files in: ${apiDir}`);
+
     // Get all markdown files from the API docs directory using absolute path
-    const apiFiles = glob.sync('docs/api/**/*.md', { absolute: true })
-    
+    // Use path.join for cross-platform compatibility
+    const apiFiles = glob.sync(path.join(apiDir, '**/*.md').replace(/\\/g, '/'), {
+      absolute: true,
+    }); // Use forward slashes for glob
+
+    // Log found files for debugging
+    console.log(`Found ${apiFiles.length} API files:`, apiFiles);
+
     // Build sidebar structure
-    const apiSidebar: SidebarItem[] = []
-    
+    const apiSidebar: SidebarItem[] = [];
+
     // Define documentation sections to process
     const sections = [
       { name: 'Modules', path: 'modules' },
       { name: 'Classes', path: 'classes' },
       { name: 'Interfaces', path: 'interfaces' },
       { name: 'Functions', path: 'functions' },
-      { name: 'Types', path: 'types' }
-    ]
+      { name: 'Types', path: 'types' },
+      // Add other sections if needed
+    ];
 
     // Process each section
     sections.forEach(({ name, path: sectionPath }) => {
-      const sectionFiles = apiFiles.filter(file => {
-        const relativePath = path.relative('docs', file)
-        return relativePath.includes(`/api/${sectionPath}/`) && !relativePath.endsWith('index.md')
-      }).map(file => {
-        const relativePath = path.relative('docs', file)
-        const basename = path.basename(file, '.md')
-        return {
-          text: basename.replace(/^_/, '').replace(/-/g, ' '),
-          link: '/' + relativePath.replace(/\.md$/, '')
-        }
-      })
-      
+      // Filter files based on the absolute path to the section directory
+      const sectionDir = path.join(apiDir, sectionPath);
+      const sectionFiles = apiFiles
+        .filter(file => {
+          // Check if the file is within the current section's directory
+          // and is not an index file directly within that section directory
+          const fileDirPath = path.dirname(file);
+          return (
+            file.startsWith(sectionDir) && fileDirPath !== sectionDir && !file.endsWith('index.md')
+          );
+          // Alternative, simpler check if structure is flat within sections:
+          // return file.startsWith(path.join(apiDir, sectionPath, '/')) && !file.endsWith('index.md');
+        })
+        .map(file => {
+          // Calculate path relative to the 'docs' directory for the link
+          const relativePath = path.relative(docsDir, file);
+          const basename = path.basename(file, '.md');
+          const link = '/' + relativePath.replace(/\\/g, '/').replace(/\.md$/, ''); // Ensure forward slashes for URL
+
+          console.log(`Processing file: ${file}, Relative Path: ${relativePath}, Link: ${link}`); // Debug log
+
+          return {
+            text: basename.replace(/^_/, '').replace(/-/g, ' '), // Basic cleanup
+            link: link,
+          };
+        })
+        .sort((a, b) => a.text.localeCompare(b.text)); // Sort items alphabetically
+
       if (sectionFiles.length > 0) {
         apiSidebar.push({
           text: name,
-          collapsed: false,
-          items: sectionFiles
-        })
+          collapsed: false, // Or true if you prefer them collapsed
+          items: sectionFiles,
+        });
       }
-    })
-    
-    // Add main API index as first item
-    apiSidebar.unshift({
-      text: 'API Reference',
-      link: '/api/'
-    })
-    
-    return apiSidebar
+    });
+
+    // Add main API index if it exists (relative to docsDir)
+    const mainApiIndex = path.join(apiDir, 'index.md'); // Or maybe README.md? Check your TypeDoc output
+    // Check if the main index file exists using glob result or fs.existsSync
+    const mainApiIndexExists = apiFiles.some(file => file === mainApiIndex);
+
+    if (mainApiIndexExists) {
+      apiSidebar.unshift({
+        text: 'API Overview', // Or 'API Reference'
+        link: '/api/', // Link to the root index file of the API section
+      });
+    } else {
+      // Maybe add a placeholder or log a warning if the main index is missing
+      console.warn(
+        'Main API index file (e.g., docs/api/index.md or docs/api/README.md) not found.'
+      );
+    }
+
+    // Log the final generated sidebar
+    console.log('Generated API Sidebar:', JSON.stringify(apiSidebar, null, 2));
+
+    return apiSidebar;
   } catch (error) {
-    console.error('Error building docs sidebar:', error)
+    console.error('Error building docs sidebar:', error);
     // Return basic sidebar if there's an error
-    return [{
-      text: 'API Reference',
-      link: '/api/'
-    }]
+    return [
+      {
+        text: 'API Reference (Error)',
+        link: '/api/',
+      },
+    ];
   }
-}
+}

package/docs/architecture.md

@@ -0,0 +1,186 @@
+# PortaPack Architecture
+
+## Overview
+
+PortaPack is a sophisticated tool that bundles entire websites—HTML, CSS, JavaScript, images, and fonts—into self-contained HTML files for offline access. This document outlines the architectural components that make up the system.
+
+```mermaid
+graph TD
+    CLI[CLI Entry Point] --> Options[Options Parser]
+    Options --> Core
+    API[API Entry Point] --> Core
+    
+    subgraph Core ["Core Pipeline"]
+        Parser[HTML Parser] --> Extractor[Asset Extractor]
+        Extractor --> Minifier[Asset Minifier]
+        Minifier --> Packer[HTML Packer]
+    end
+    
+    subgraph Recursive ["Advanced Features"]
+        WebFetcher[Web Fetcher] --> MultipageBundler[Multipage Bundler]
+    end
+    
+    WebFetcher --> Parser
+    Core --> Output[Bundled HTML]
+    MultipageBundler --> Output
+    
+    subgraph Utilities ["Utilities"]
+        Logger[Logger]
+        MimeUtils[MIME Utilities]
+        BuildTimer[Build Timer]
+        Slugify[URL Slugifier]
+    end
+    
+    Logger -.-> CLI
+    Logger -.-> Core
+    Logger -.-> Recursive
+    MimeUtils -.-> Extractor
+    MimeUtils -.-> Parser
+    BuildTimer -.-> CLI
+    BuildTimer -.-> API
+    Slugify -.-> MultipageBundler
+```
+
+## Entry Points
+
+### CLI Interface
+
+The command-line interface provides a convenient way to use PortaPack through terminal commands:
+
+| Component | Purpose |
+|-----------|---------|
+| `cli-entry.ts` | Executable entry point with shebang support |
+| `cli.ts` | Main runner that processes args and manages execution |
+| `options.ts` | Parses command-line arguments and normalizes options |
+
+### API Interface
+
+The programmatic API enables developers to integrate PortaPack into their applications:
+
+| Component | Purpose |
+|-----------|---------|
+| `index.ts` | Exports public functions like `pack()` with TypeScript types |
+| `types.ts` | Defines shared interfaces and types for the entire system |
+
+## Core Pipeline
+
+The bundling process follows a clear four-stage pipeline:
+
+### 1. HTML Parser (`parser.ts`)
+
+The parser reads and analyzes the input HTML:
+- Uses Cheerio for robust HTML parsing
+- Identifies linked assets through element attributes (href, src, etc.)
+- Creates an initial asset list with URLs and inferred types
+- Handles both local file paths and remote URLs
+
+### 2. Asset Extractor (`extractor.ts`)
+
+The extractor resolves and fetches all referenced assets:
+- Resolves relative URLs against the base context
+- Fetches content for all discovered assets
+- Recursively extracts nested assets from CSS (@import, url())
+- Handles protocol-relative URLs and different origins
+- Provides detailed logging of asset discovery
+
+### 3. Asset Minifier (`minifier.ts`)
+
+The minifier reduces the size of all content:
+- Minifies HTML using html-minifier-terser
+- Minifies CSS using clean-css
+- Minifies JavaScript using terser
+- Preserves original content if minification fails
+- Configurable through command-line flags
+
+### 4. HTML Packer (`packer.ts`)
+
+The packer combines everything into a single file:
+- Inlines CSS into `<style>` tags
+- Embeds JavaScript into `<script>` tags
+- Converts binary assets to data URIs
+- Handles srcset attributes properly
+- Ensures proper HTML structure with base tag
+
+## Advanced Features
+
+### Web Fetcher (`web-fetcher.ts`)
+
+For remote content, the web fetcher provides crawling capabilities:
+- Uses Puppeteer for fully-rendered page capture
+- Crawls websites recursively to specified depth
+- Respects same-origin policy by default
+- Manages browser instances efficiently
+- Provides detailed logging of the crawl process
+
+### Multipage Bundler (`bundler.ts`)
+
+For bundling multiple pages into a single file:
+- Combines multiple HTML documents into one
+- Creates a client-side router for navigation
+- Generates a navigation interface
+- Uses slugs for routing between pages
+- Handles page templates and content swapping
+
+## Utilities
+
+### Logger (`logger.ts`)
+- Customizable log levels (debug, info, warn, error)
+- Consistent logging format across the codebase
+- Optional timestamps and colored output
+
+### MIME Utilities (`mime.ts`)
+- Maps file extensions to correct MIME types
+- Categorizes assets by type (CSS, JS, image, font)
+- Provides fallbacks for unknown extensions
+
+### Build Timer (`meta.ts`)
+- Tracks build performance metrics
+- Records asset counts and page counts
+- Captures output size and build duration
+- Collects errors and warnings for reporting
+
+### URL Slugifier (`slugify.ts`)
+- Converts URLs to safe HTML IDs
+- Handles special characters and normalization
+- Prevents slug collisions in multipage bundles
+
+## Asynchronous Processing
+
+PortaPack uses modern async patterns throughout:
+
+- **Promise-based Pipeline**: Each stage returns promises that are awaited
+- **Sequential Processing**: Assets are processed in order to avoid overwhelming resources
+- **Error Boundaries**: Individual asset failures don't break the entire pipeline
+- **Resource Management**: Browser instances and file handles are properly closed
+
+## Build System
+
+PortaPack uses a dual build configuration:
+
+| Build Target | Format | Purpose |
+|--------------|--------|---------|
+| CLI | CommonJS (.cjs) | Works with Node.js and npx |
+| API | ESModule (.js) | Modern import/export support |
+
+TypeScript declarations (.d.ts) are generated for API consumers, and source maps support debugging.
+
+## Current Limitations
+
+### Script Execution Issues
+
+- Inlined scripts with `async`/`defer` attributes lose their intended loading behavior
+- ES Modules with import/export statements may fail after bundling
+- Script execution order can change, breaking dependencies
+
+### Content Limitations
+
+- CORS policies may prevent access to some cross-origin resources
+- Only initially rendered content from SPAs is captured by default
+- Very large sites produce impractically large HTML files
+
+### Technical Constraints
+
+- No streaming API or WebSocket support
+- Service worker capabilities are not preserved
+- Memory pressure with large sites
+- Limited support for authenticated content

package/docs/cli.md

@@ -26,25 +26,25 @@ Where `[input]` is the path to a local HTML file or a remote URL.
 
 ## Options
 
-| Option | Shorthand | Description | Default |
-|--------|-----------|-------------|---------|
-| `[input]` | | Required. Input local file path or remote URL (http/https) to process. | - |
-| `--output <file>` | `-o` | Output file path for the bundled HTML. | `{input-basename}.packed.html` |
-| `--recursive [depth]` | `-r` | Recursively bundle links up to depth. If depth omitted, defaults to true (no limit). Only applies to remote URLs. | `false` (disabled) |
-| `--max-depth <n>` | | Set maximum depth for recursive crawling (alternative to `-r <n>`). | - |
-| `--minify` | `-m` | Enable all minification (HTML, CSS, JS). | - |
-| `--no-minify` | | Disable all asset minification (HTML, CSS, JS). | `false` |
-| `--no-minify-html` | | Disable only HTML minification. | `false` |
-| `--no-minify-css` | | Disable only CSS minification. | `false` |
-| `--no-minify-js` | | Disable only JavaScript minification. | `false` |
-| `--embed-assets` | `-e` | Embed external assets (CSS, JS, images, fonts) as data URIs or inline content. | `true` |
-| `--no-embed-assets` | | Keep external assets as links (requires network access when viewing). | `false` |
-| `--base-url <url>` | `-b` | Base URL for resolving relative URLs found in the input HTML. | Input path/URL |
-| `--log-level <level>` | | Set logging level (debug, info, warn, error, silent, none). | `info` |
-| `--verbose` | `-v` | Enable verbose logging (shortcut for `--log-level debug`). | `false` |
-| `--dry-run` | `-d` | Perform all steps except writing the output file. Logs intended actions. | `false` |
-| `--help` | `-h` | Show help information and exit. | - |
-| `--version` | | Show PortaPack CLI version number and exit. | - |
+| Option                | Shorthand | Description                                                                                                       | Default                        |
+| --------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------ |
+| `[input]`             |           | Required. Input local file path or remote URL (http/https) to process.                                            | -                              |
+| `--output <file>`     | `-o`      | Output file path for the bundled HTML.                                                                            | `{input-basename}.packed.html` |
+| `--recursive [depth]` | `-r`      | Recursively bundle links up to depth. If depth omitted, defaults to true (no limit). Only applies to remote URLs. | `false` (disabled)             |
+| `--max-depth <n>`     |           | Set maximum depth for recursive crawling (alternative to `-r <n>`).                                               | -                              |
+| `--minify`            | `-m`      | Enable all minification (HTML, CSS, JS).                                                                          | -                              |
+| `--no-minify`         |           | Disable all asset minification (HTML, CSS, JS).                                                                   | `false`                        |
+| `--no-minify-html`    |           | Disable only HTML minification.                                                                                   | `false`                        |
+| `--no-minify-css`     |           | Disable only CSS minification.                                                                                    | `false`                        |
+| `--no-minify-js`      |           | Disable only JavaScript minification.                                                                             | `false`                        |
+| `--embed-assets`      | `-e`      | Embed external assets (CSS, JS, images, fonts) as data URIs or inline content.                                    | `true`                         |
+| `--no-embed-assets`   |           | Keep external assets as links (requires network access when viewing).                                             | `false`                        |
+| `--base-url <url>`    | `-b`      | Base URL for resolving relative URLs found in the input HTML.                                                     | Input path/URL                 |
+| `--log-level <level>` |           | Set logging level (debug, info, warn, error, silent, none).                                                       | `info`                         |
+| `--verbose`           | `-v`      | Enable verbose logging (shortcut for `--log-level debug`).                                                        | `false`                        |
+| `--dry-run`           | `-d`      | Perform all steps except writing the output file. Logs intended actions.                                          | `false`                        |
+| `--help`              | `-h`      | Show help information and exit.                                                                                   | -                              |
+| `--version`           |           | Show PortaPack CLI version number and exit.                                                                       | -                              |
 
 ## Examples
 
@@ -169,12 +169,12 @@ npx portapack ./index.html -o bundle.html
 ## Exit Codes
 
 | Code | Description |
-|------|-------------|
-| 0 | Success |
-| 1 | Error |
+| ---- | ----------- |
+| 0    | Success     |
+| 1    | Error       |
 
 ## Related Resources
 
 - [Getting Started](https://manicinc.github.io/portapack/getting-started)
 - [API Reference](https://manicinc.github.io/portapack/api/)
-- [Configuration Guide](https://manicinc.github.io/portapack/configuration)
+- [Configuration Guide](https://manicinc.github.io/portapack/configuration)

package/docs/code-of-conduct.md

@@ -3,6 +3,7 @@
 ## Our Pledge
 
 We are committed to providing a friendly, safe, and welcoming environment for all contributors, regardless of:
+
 - Age
 - Body size
 - Disability
@@ -18,6 +19,7 @@ We are committed to providing a friendly, safe, and welcoming environment for al
 ## Our Standards
 
 ### Positive Behavior
+
 - Using welcoming and inclusive language
 - Being respectful of differing viewpoints
 - Gracefully accepting constructive criticism
@@ -25,6 +27,7 @@ We are committed to providing a friendly, safe, and welcoming environment for al
 - Showing empathy towards other community members
 
 ### Unacceptable Behavior
+
 - Trolling, insulting/derogatory comments
 - Public or private harassment
 - Publishing others' private information
@@ -33,6 +36,7 @@ We are committed to providing a friendly, safe, and welcoming environment for al
 ## Enforcement Responsibilities
 
 Community leaders are responsible for:
+
 - Clarifying acceptable behavior standards
 - Providing fair and consistent feedback
 - Removing, editing, or rejecting contributions that violate this Code of Conduct
@@ -40,6 +44,7 @@ Community leaders are responsible for:
 ## Reporting Issues
 
 If you experience or witness unacceptable behavior:
+
 1. Email [conduct@manicinc.com](mailto:conduct@manicinc.com)
 2. Provide:
    - Your contact information
@@ -50,6 +55,7 @@ If you experience or witness unacceptable behavior:
 ## Consequences
 
 Violations may result in:
+
 - Temporary or permanent ban from community spaces
 - Removal of contributions
 - Public or private warnings
@@ -62,4 +68,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 
 ## License
 
-This Code of Conduct is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
+This Code of Conduct is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).

package/docs/configuration.md

@@ -36,7 +36,7 @@ import { pack } from 'portapack';
 async function bundleLocalSite() {
   const result = await pack('./index.html');
   console.log(result.html);
-  
+
   // Access metadata about the build
   console.log(`Output size: ${result.metadata.outputSize} bytes`);
   console.log(`Build time: ${result.metadata.buildTimeMs} ms`);
@@ -49,9 +49,9 @@ async function bundleWithOptions() {
     minifyCss: true,
     minifyJs: true,
     baseUrl: 'https://example.com',
-    embedAssets: true
+    embedAssets: true,
   });
- 
+
   // Use or save the bundled HTML
   console.log(result.html);
 }
@@ -59,12 +59,12 @@ async function bundleWithOptions() {
 // Recursive bundling of a website
 async function bundleWebsite() {
   const result = await pack('https://example.com', {
-    recursive: 2,  // Crawl up to 2 levels deep
+    recursive: 2, // Crawl up to 2 levels deep
     minifyHtml: true,
     minifyCss: true,
-    minifyJs: true
+    minifyJs: true,
   });
-  
+
   console.log(`Bundled ${result.metadata.pagesBundled} pages`);
 }
 ```
@@ -83,18 +83,18 @@ import {
 
 // Bundle a single HTML file or URL
 const singleResult = await generatePortableHTML('./index.html', {
-  minifyHtml: true
+  minifyHtml: true,
 });
 
 // Recursively bundle a site
 const recursiveResult = await generateRecursivePortableHTML('https://example.com', 2, {
-  minifyCss: true
+  minifyCss: true,
 });
 
 // Create multi-page bundle
 const multiPageBundle = await bundleMultiPageHTML([
   { path: '/', html: '<html>...</html>' },
-  { path: '/about', html: '<html>...</html>' }
+  { path: '/about', html: '<html>...</html>' },
 ]);
 ```
 
@@ -117,7 +117,7 @@ For details, see the [CLI Reference](https://manicinc.github.io/portapack/cli).
 
 - 📖 [Explore CLI Options](https://manicinc.github.io/portapack/cli)
 - 🛠 [Advanced Configuration](https://manicinc.github.io/portapack/configuration)
-- 💻 [API Reference](https://manicinc.github.io/portapack/api/)
+- 💻 [API Reference](https://manicinc.github.io/portapack/api/README.html)
 
 ## Troubleshooting
 
@@ -126,6 +126,7 @@ Encountering issues? Check our [Troubleshooting Guide](https://manicinc.github.i
 ## Contributing
 
 Interested in improving PortaPack?
+
 - [View Contributing Guidelines](https://manicinc.github.io/portapack/contributing)
 
 ## Support
@@ -133,4 +134,4 @@ Interested in improving PortaPack?
 - 🐛 [Report an Issue](https://github.com/manicinc/portapack/issues)
 - 💬 [Community Support](https://discord.gg/DzNgXdYm)
 
-Built by [Manic.agency](https://manic.agency)
+Built by [Manic.agency](https://manic.agency)