Skip to content

Documentation overview

The documentation is organised by what you are trying to do. Use this page to find the right section, then follow the reading order it suggests.

Choose a path

You want to...Start withThen
Embed a PowerPoint viewer or editor in a web appYour framework's getting-started page: React, Vue 3, Angular, Svelte 5, Vanilla JSThe same section's props/API reference, then Theming and Localization
Read, edit, or generate .pptx files from codeCore: Loading & Parsing and the Builder APIEditing, Saving, the data model
Convert presentations to Markdown, images, PDF, or SVGMarkdown Converter and SVG ExportYour binding's Export page for in-browser formats
Use the editor UI (you are not writing code)User GuideEditing Slides, Keyboard Shortcuts
Let AI agents or scripts work with presentationsMCP & ToolsCore CLI
Understand how the library works internallyArchitectureOOXML conformance, Limitations

New to the project

If none of the paths above fits yet, read these three pages in order:

  1. What is pptx-viewer?: the package family and what each part does.
  2. Installation: which package to install for your stack.
  3. Quick Start: four end-to-end flows using the public API.

Sections at a glance

SectionAudienceContents
Developer Guide (this section)DevelopersConcepts that apply to every package: architecture, data model, theming, i18n, limitations.
CoreDevelopersThe headless engine: load, edit, build, save, convert, encrypt. No UI.
React / Vue / Angular / Svelte / VanillaDevelopersOne section per UI binding: getting started, props/API, theming, export, collaboration.
User GuideEnd users of the editorHow to view, edit, present, export, and collaborate in the editor UI. No code.
MCP & ToolsAgent/automation authorsThe MCP server, its 50+ tools, and the CLI.
ReleasesEveryonePer-package release notes.

Released under the Apache-2.0 License.