adobe/skills

preview-import

Use this when you need to preview and verify content you imported into a local AEM Edge Delivery Services (EDS, Franklin, Helix) dev server on localhost.

View source

How to use

  1. Copy the installation command and review the source package before installing it in your own agent environment.
  2. Check the source document for required tools, credentials and supported hosts.
  3. Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/adobe/skills --skill preview-import

Before you start

  • Installation does not include a model subscription, API allowance or permission to access your files.
  • Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

Preview Import

Open and verify imported content in local development server.

When to Use This Skill

Use this skill when:

  • You have generated HTML file (from generate-import-html)
  • Ready to preview in browser and verify rendering
  • Need to compare with original page structure

Invoked by: page-import skill (Step 5)

Prerequisites

From previous skills, you need:

  • ✅ HTML file at correct path (from generate-import-html)
  • ✅ Images folder in same directory
  • ✅ screenshot.png from scrape-webpage (for comparison)
  • ✅ documentPath from metadata.json (for URL construction)

Related Skills

  • page-import - Orchestrator that invokes this skill
  • generate-import-html - Provides HTML file to preview
  • scrape-webpage - Provides screenshot for comparison

Preview Workflow

Step 1: Start Development Server with HTML Folder Flag

Determine the folder from metadata.json:

  • Look at paths.dirPath from metadata.json (e.g., /us)
  • This is the root folder containing your imported HTML file

Command:

bash
aem up --html-folder {dirPath}

Examples based on imported content location:

HTML File LocationCommandPreview URL
us/en.plain.htmlaem up --html-folder ushttp://localhost:3000/us/en
products/widget.plain.htmlaem up --html-folder productshttp://localhost:3000/products/widget
blog/2024/post.plain.htmlaem up --html-folder bloghttp://localhost:3000/blog/2024/post

Why this is required:

  • Without --html-folder, AEM CLI proxies requests to the remote server
  • The remote server doesn't have your locally imported content
  • Result: 404 "Page not found" errors

Step 2: Navigate in Browser

For most files, use the document path directly:

http://localhost:3000${documentPath}

Example:

  • HTML file: us/en/about.plain.html
  • URL: http://localhost:3000/us/en/about

IMPORTANT: For index files, use `/` instead of `/index`:

If file is: index.plain.html
Preview at: http://localhost:3000/
NOT: http://localhost:3000/index

Note: If you used --html-folder flag (e.g., aem up --html-folder drafts), prepend that folder to the URL:

File: drafts/test.plain.html
URL: http://localhost:3000/drafts/test

Use paths.documentPath from metadata.json, but for index files ensure the path is / not /index


Step 3: Verify Rendering

Check the following:

  • ✅ Blocks render with correct styling
  • ✅ Layout matches original page structure (compare to screenshot.png)
  • ✅ Images load (or show appropriate placeholders)
  • ✅ No raw HTML visible
  • ✅ Metadata appears in page source (view source, check <meta> tags)
  • ✅ Section styling applied correctly

Step 4: Compare with Original

Side-by-side comparison:

  1. Open ./import-work/screenshot.png alongside browser preview
  2. Check that content structure matches
  3. Verify blocks decorated correctly
  4. Confirm section boundaries align
  5. Validate styling consistency

Troubleshooting

Blocks don't render correctly:

Images not loading:

  • Verify images folder is in same directory as HTML file
  • Check image paths are ./images/... format
  • Ensure images were copied correctly from ./import-work/images/

Raw HTML visible:

  • Block name might not match existing block in project
  • Check browser console for JavaScript errors
  • Verify block exists in blocks/ directory

Metadata not in page source:

  • Check metadata block is at end of HTML file
  • View page source and search for <meta> tags in <head>
  • Verify metadata properties match expected format

Dev server not running:

  • Start server with aem up
  • Check for port conflicts (default 3000)
  • Verify you're in correct project directory

Page not found (404):

  • Most common cause: Missing --html-folder flag - restart server with aem up --html-folder {dirPath}
  • Verify HTML file exists at expected path
  • Check documentPath from metadata.json matches URL
  • For index files, use / not /index
  • Check terminal output confirms "Serving HTML files from folder: {folder}"

Output

This skill provides:

  • ✅ Verified preview that matches original page structure
  • ✅ Visual confirmation of correct rendering
  • ✅ Validated block decoration
  • ✅ Confirmed metadata presence

Import complete when all verification points pass.

Related by task

from this repository

More skills

All skills
adobe
Community

adobe-edit-quick-cut

Create a punchy highlight cut from a video with Adobe Quick Cut — for requests like "make a sizzle reel", "make a highlight reel", "quick cut this", "cut the best parts", "shorten this video", "make a highlight clip", or "summarize this video visually". Works from the user's original request without follow-up questions and produces one highlight cut. Do NOT use it for exact-timestamp trims ("cut from 0:30 to 1:15") or other deterministic edits — Quick Cut selects moments by relevance, not exact

installs
1
GitHub stars
306
Updated
Oct 24
adobe
Community

appbuilder-project-init

Initialize an Adobe App Builder project end-to-end and prepare the machine to build one. Creates the Console project and workspace, subscribes APIs (including those needing a product profile), maps intent to the right template, runs non-interactive aio app init, and guides post-init customization. Use whenever the user mentions creating an App Builder app, scaffolding a project, aio app init, an Experience Cloud extension, adding actions or web assets, or creating a Console project/workspace — e

installs
2
GitHub stars
268
Updated
Oct 20
adobe
Community

commerce-app-admin-ui

Add or modify Adobe Commerce Admin UI extensions on the commerce/backend-ui/2 extension point: custom grid columns, mass actions, order view buttons, a custom Admin menu entry, and custom ACL resources. Use whenever the user wants to extend the Commerce Admin — add a column to the order, product, or customer grid, add a bulk/mass action to a grid, add a button to the order view page, add a custom menu item or page, or declare custom permissions the app checks itself — even when they don't name t

installs
2
GitHub stars
268
Updated
Oct 20
adobe
Community

commerce-app-business-config

Manage custom business configuration in an Adobe Commerce app. Use when the user wants to add, modify, or remove merchant-configurable settings (config fields, admin config, store configuration) exposed through Commerce Admin. Creates typed config fields (text, password, email, url, tel, boolean, list) in businessConfig.schema. Requires a base app initialized with commerce-app-init.

installs
2
GitHub stars
268
Updated
Oct 20