remove-preview-highlighting

Remove preview-only markup and wrappers from Workfront Markdown documents.

Updated Feb 10, 2023
One-click install
npx skills add https://github.com/AdobeDocs/workfront.ko-KR --skill remove-preview-highlighting
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: remove-preview-highlighting
Source: https://github.com/AdobeDocs/workfront.ko-KR/tree/main/.cursor/skills/remove-preview-highlighting
Command: npx skills add https://github.com/AdobeDocs/workfront.ko-KR --skill remove-preview-highlighting

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Removes preview-only markup, boilerplate, and wrappers from Workfront Markdown documents so authors can convert preview or sandboxed content into general-availability (GA) documentation without breaking structure or losing author attribution.

Core Features & Use Cases

  • Automated detection: Identifies files under help/ trees that match scope rules, checks frontmatter for the specified author, and excludes product-announcements and explicit excluded paths.
  • Safe, human-in-the-loop edits: Proposes clear before/after excerpts and focused edit suggestions (for example, removing preview-only paragraphs, unwrapping elements with class="preview", and normalizing parallel sections) and waits for explicit approval before writing changes.
  • Structural preservation: Preserves list and table structure, avoids automated changes to HTML comments, and flags ambiguous or parallel content for manual decision-making.
  • Use case: An editor needs to convert a preview-marked feature article into GA language while preserving numbering and tables; this skill inventories candidates, generates precise edits, and prompts for confirmation before applying them.

Quick Start

Run the remove-preview-highlighting skill on a target help/ Markdown file to produce a curated set of suggested edits and a before-and-after excerpt for approval.

Frequently Asked Questions about remove-preview-highlighting

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I remove preview-only markup from Markdown documentation files?

Removing preview markup from Markdown documentation involves stripping preview boilerplate and unwrapping class="preview" elements while preserving structure. The skill identifies scoped help/ files, generates precise edit suggestions, and waits for human approval before writing changes.

Can I automatically convert Workfront preview content into GA-ready documentation?

Yes, you can convert Workfront preview content into GA-ready documentation by running an automated detection process. It inventories help/ Markdown files matching author and scope rules, excludes product-announcements, and proposes human-reviewable edits before applying any changes.

What is the best way to strip preview wrappers from Markdown without breaking tables and lists?

The best way to strip preview wrappers without breaking tables and lists is to use a process focused on structural preservation. It unwraps preview elements, avoids automated changes to HTML comments, and flags ambiguous parallel content for manual decision-making.

Does the preview markup removal process exclude specific paths and TOC pages?

Yes, the preview markup removal process explicitly excludes specified excluded paths, product-announcements, and TOC or index pages. It applies only to Workfront help/ documentation files that meet defined author and scope rules.

Why does the Markdown cleanup process pause on ambiguous content for manual decision?

The Markdown cleanup process pauses on ambiguous content to ensure safe, human-in-the-loop edits. Instead of automatically modifying uncertain parallel sections or HTML comments, it provides before-and-after excerpts and waits for explicit approval before applying changes.