README.md

doc-schema-version	1
title	Documentation
summary	Index of maintained PptxGenJS fork documentation and documentation rules.
read_when	Looking for the maintained docs surface Updating documentation structure or rules
doc_type	overview

Documentation

This directory contains the maintained project documentation for this PptxGenJS fork. Prefer docs here over legacy upstream-era notes in demos or generated artifacts.

Start Here

• Project target: what this project is optimized for.
• Runtime and package support: supported imports, dropped upstream support, and shipped artifacts.
• Development guide: setup, source layout, generated outputs, and contribution rules.
• Testing guide: regression, schema, package, demo, and manual verification.
• Release workflow: scoped-package release preparation, automated npm publishing, and package-surface checks.
• Agent development guide: expectations for Codex and other agent-assisted changes.
• OOXML agent context: project-specific OOXML reference and validation workflow.
• Backlog workflow: how to classify upstream issues and PRs without reintroducing dropped package targets.

Feature Guides

• Grouping objects: addGroup() / groupObjects(), the identity child space, framing, nesting, and cross-references into a group.
• Connectors: addConnector() straight/elbow/curved lines, bend control, shape binding, and the addShape() vs. addConnector() split.
• Image embedded in a shape: clip a picture to a preset or freeform shape and crop it to fill the box.
• OLE embedded objects: addOleObject() embeds a workbook, document, or any payload so it opens in place on double-click.
• Animations and transitions: slide/shape animation and transition emit.
• Native backgrounds and gradients: native PPTX gradient fills and required review gates.
• Math and LaTeX: OMML math emit.
• Embedded fonts: font embedding, merge, and fixtures.
• Measured text fit: the export-time shrink/resize pass.

Documentation Rules

• Keep docs aligned with the current package target.
• Do not document CJS or IIFE as supported workflows.
• Keep release runtime and declaration artifacts under dist/ treated as generated outputs unless a task explicitly asks to refresh them.
• For OOXML behavior, prefer small repo-specific notes with section references over copied standards text.