@see-ms/converter 0.1.1 → 0.1.3

package/README.md

@@ -5,22 +5,26 @@ CLI tool for converting HTML exports to Nuxt 3 projects with automatic CMS integ
 ## Features
 
 ✨ **Automatic Conversion**
+
 - Convert HTML to Vue components
 - Transform `<a>` tags to `<NuxtLink>` with proper routing
 - Normalize all asset paths automatically
 
 🎨 **Asset Management**
+
 - CSS files → `assets/css/`
 - Images, fonts, JS → `public/assets/`
 - Auto-generate Vite plugin for path resolution (For Webflow)
 
 🔧 **Smart Transforms**
+
 - Extract and deduplicate embedded styles
 - Remove unnecessary attributes (srcset, sizes)
 - Clean up script tags and inline code
 - Format output with Prettier
 
 📦 **Boilerplate Support**
+
 - Clone from GitHub repository
 - Copy from local directory
 - Works with your custom Nuxt boilerplate
@@ -30,11 +34,13 @@ CLI tool for converting HTML exports to Nuxt 3 projects with automatic CMS integ
 ## Installation
 
 ### Quick Use (npx - no installation)
+
 ```bash
 npx @see-ms/converter convert <webflow-export> <output-dir> [options]
 ```
 
 ### Global Installation
+
 ```bash
 npm install -g @see-ms/converter
 # or
@@ -42,6 +48,7 @@ pnpm add -g @see-ms/converter
 ```
 
 Then use anywhere:
+
 ```bash
 cms convert <webflow-export> <output-dir> [options]
 ```
@@ -51,11 +58,13 @@ cms convert <webflow-export> <output-dir> [options]
 ## Usage
 
 ### Basic Conversion
+
 ```bash
 cms convert ./my-webflow-export ./my-nuxt-site
 ```
 
 ### With Boilerplate (Recommended)
+
 ```bash
 # From GitHub
 cms convert ./webflow-export ./nuxt-site \
@@ -67,9 +76,10 @@ cms convert ./webflow-export ./nuxt-site \
 ```
 
 ### Full Example
+
 ```bash
-cms convert ./jagal.webflow ./jagal-nuxt \
-  --boilerplate git@github.com:Check-DC/customer-boilerplate.git \
+cms convert ./project-html ./project-nuxt \
+  --boilerplate git@github.com:username/repo-boilerplate.git \
   --cms strapi
 ```
 
@@ -77,12 +87,12 @@ cms convert ./jagal.webflow ./jagal-nuxt \
 
 ## Options
 
-| Option | Description | Default |
-|--------|-------------|---------|
-| `-b, --boilerplate <source>` | GitHub URL or local path to Nuxt boilerplate | none |
-| `-o, --overrides <path>` | Path to overrides JSON file | none |
-| `--generate-schemas` | Generate CMS schemas after conversion | false |
-| `--cms <type>` | CMS type: strapi, contentful, or sanity | strapi |
+| Option                       | Description                                  | Default |
+|------------------------------|----------------------------------------------|---------|
+| `-b, --boilerplate <source>` | GitHub URL or local path to Nuxt boilerplate | none    |
+| `-o, --overrides <path>`     | Path to overrides JSON file                  | none    |
+| `--generate-schemas`         | Generate CMS schemas after conversion        | false   |
+| `--cms <type>`               | CMS type: strapi, contentful, or sanity      | strapi  |
 
 ---
 
@@ -91,6 +101,7 @@ cms convert ./jagal.webflow ./jagal-nuxt \
 ### HTML → Vue Components
 
 **Before (Webflow):**
+
 ```html
 <!-- index.html -->
 <a href="about.html">About</a>
@@ -98,10 +109,11 @@ cms convert ./jagal.webflow ./jagal-nuxt \
 ```
 
 **After (Nuxt):**
+
 ```vue
 <!-- pages/index.vue -->
 <script setup lang="ts">
-// Page: index
+  // Page: index
 </script>
 
 <template>
@@ -113,6 +125,7 @@ cms convert ./jagal.webflow ./jagal-nuxt \
 ```
 
 ### Asset Structure
+
 ```
 webflow-export/              nuxt-project/
 ├── css/                  →  ├── assets/css/
@@ -133,28 +146,33 @@ webflow-export/              nuxt-project/
 ## Transformations Applied
 
 ### Links
+
 - `<a href="about.html">` → `<NuxtLink to="/about">`
 - `<a href="../index.html">` → `<NuxtLink to="/">`
 - `<a href="index.html">` → `<NuxtLink to="/">`
 - External links remain as `<a>` tags
 
 ### Images
+
 - `images/logo.svg` → `/assets/images/logo.svg`
 - Removes `srcset` and `sizes` attributes
 - Normalizes relative paths
 
 ### Styles
+
 - Extracts `.global-embed` styles (For Webflow)
 - Deduplicates repeated styles
 - Adds to `assets/css/main.css`
 
 ### Scripts
+
 - Removes all inline `<script>` tags
 - Cleans up Webflow-specific JavaScript
 
 ---
 
 ## Output Structure
+
 ```
 my-nuxt-site/
 ├── pages/
@@ -182,12 +200,14 @@ my-nuxt-site/
 ## After Conversion
 
 1. **Install dependencies:**
+
 ```bash
    cd my-nuxt-site
    pnpm install
 ```
 
 2. **Start development server:**
+
 ```bash
    pnpm dev
 ```
@@ -212,6 +232,7 @@ If you have a standard Nuxt boilerplate for all projects:
 
 1. Create a GitHub repo with your boilerplate
 2. Use it in every conversion:
+
 ```bash
    cms convert ./webflow ./output --boilerplate git@github.com:you/boilerplate.git
 ```
@@ -225,6 +246,7 @@ If you have a standard Nuxt boilerplate for all projects:
 ### Handling Custom Code
 
 If your Webflow site has custom JavaScript that you need:
+
 1. The converter removes inline scripts for clean Vue components
 2. Port necessary JavaScript to Vue composables or plugins
 3. Add to your Nuxt `plugins/` or `composables/` folders
@@ -236,28 +258,31 @@ If your Webflow site has custom JavaScript that you need:
 ### `nuxt.config.ts not found`
 
 The converter expects a `nuxt.config.ts` file. Either:
+
 - Use a boilerplate that has one, or
 - The converter will create a minimal one if no boilerplate is specified
 
 ### Assets not loading
 
 Make sure the `webflow-assets.ts` plugin is imported in your `nuxt.config.ts`:
+
 ```typescript
 import webflowAssets from './utils/webflow-assets'
 
 export default defineNuxtConfig({
-  vite: {
-    plugins: [webflowAssets()]
-  }
+    vite: {
+        plugins: [webflowAssets()]
+    }
 })
 ```
 
 ### Routes not working
 
 Check that your `pages/` directory is enabled in Nuxt. It should be automatic, but verify in `nuxt.config.ts`:
+
 ```typescript
 export default defineNuxtConfig({
-  pages: true
+    pages: true
 })
 ```