pptx-glimpse 0.1.2 → 0.1.3

package/README.md

@@ -2,9 +2,9 @@
 
 [![npm](https://img.shields.io/npm/v/pptx-glimpse)](https://www.npmjs.com/package/pptx-glimpse)
 
-A TypeScript library to render PPTX slides as SVG / PNG.
+A Node.js library to render PPTX as SVG / PNG.
 
-[Demo](https://hirokisakabe.github.io/pptx-glimpse/) | [npm](https://www.npmjs.com/package/pptx-glimpse)
+[Demo](https://pptx-glimpse.vercel.app/) | [npm](https://www.npmjs.com/package/pptx-glimpse)
 
 ## Motivation
 
@@ -21,8 +21,7 @@ rather than pixel-perfect rendering of every PowerPoint feature.
 
 ## Requirements
 
-- **Node.js >= 20** (does not work in browser environments)
-- Requires a platform supported by [sharp](https://sharp.pixelplumbing.com/), which is used for PNG conversion
+- **Node.js >= 20**
 
 ## Installation
 
@@ -33,7 +32,7 @@ npm install pptx-glimpse
 ## Usage
 
 ```typescript
-import { readFileSync } from "fs";
+import { readFileSync, writeFileSync } from "fs";
 import { convertPptxToSvg, convertPptxToPng } from "pptx-glimpse";
 
 const pptx = readFileSync("presentation.pptx");
@@ -45,6 +44,67 @@ const svgResults = await convertPptxToSvg(pptx);
 // Convert to PNG
 const pngResults = await convertPptxToPng(pptx);
 // [{ slideNumber: 1, png: Buffer, width: 960, height: 540 }, ...]
+
+writeFileSync("slide1.png", pngResults[0].png);
+```
+
+### Options
+
+Both `convertPptxToSvg` and `convertPptxToPng` accept an optional `ConvertOptions` object.
+
+```typescript
+const results = await convertPptxToPng(pptx, {
+  slides: [1, 3], // Convert only slides 1 and 3
+  width: 1920, // Output width in pixels (default: 960)
+  logLevel: "warn", // Warning log level: "off" | "warn" | "error"
+  fontDirs: ["/custom/fonts"], // Additional font directories to search
+  fontMapping: {
+    "Custom Corp Font": "Noto Sans", // Custom font name mapping
+  },
+});
+```
+
+## Fonts
+
+### Automatic Font Loading
+
+pptx-glimpse automatically scans system font directories and loads fonts using [opentype.js](https://opentype.js.org/). Text in SVG output is converted to `<path>` elements, ensuring consistent rendering regardless of the environment.
+
+Default system font directories:
+
+| OS      | Directories                                                  |
+| ------- | ------------------------------------------------------------ |
+| Linux   | `/usr/share/fonts`, `/usr/local/share/fonts`                 |
+| macOS   | `/System/Library/Fonts`, `/Library/Fonts`, `~/Library/Fonts` |
+| Windows | `C:\Windows\Fonts`                                           |
+
+Use the `fontDirs` option to add custom font directories.
+
+### Font Mapping
+
+PPTX files often reference proprietary fonts (e.g., Calibri, Meiryo). pptx-glimpse maps these to open-source alternatives available on Google Fonts.
+
+Default mapping:
+
+| PPTX Font                           | Mapped to     |
+| ----------------------------------- | ------------- |
+| Calibri                             | Carlito       |
+| Arial                               | Arimo         |
+| Times New Roman                     | Tinos         |
+| Courier New                         | Cousine       |
+| Cambria                             | Caladea       |
+| Meiryo / Yu Gothic / MS Gothic etc. | Noto Sans JP  |
+| MS Mincho / Yu Mincho etc.          | Noto Serif JP |
+
+You can customize the mapping via the `fontMapping` option:
+
+```typescript
+const results = await convertPptxToSvg(pptx, {
+  fontMapping: {
+    "Custom Corp Font": "Noto Sans", // Add a new mapping
+    Arial: "Inter", // Override the default
+  },
+});
 ```
 
 ## Feature Support
@@ -127,10 +187,10 @@ Supports conversion of static visual content in PowerPoint. Dynamic elements suc
 
 #### Charts
 
-| Feature          | Details                                                                                    |
-| ---------------- | ------------------------------------------------------------------------------------------ |
-| Supported charts | Bar chart (vertical/horizontal), line chart, pie chart, scatter plot                       |
-| Chart elements   | Title, legend (position), series (name/values/categories/color), category axis, value axis |
+| Feature          | Details                                                                                                      |
+| ---------------- | ------------------------------------------------------------------------------------------------------------ |
+| Supported charts | Bar chart (vertical/horizontal), line chart, pie chart, scatter plot, area chart, doughnut, bubble, radar     |
+| Chart elements   | Title, legend (position), series (name/values/categories/color), category axis, value axis                   |
 
 #### SmartArt
 
@@ -154,9 +214,9 @@ Supports conversion of static visual content in PowerPoint. Dynamic elements suc
 | -------------- | ---------------------------------------------------------------------------------------------- |
 | Fill           | Path gradient (rect/shape type)                                                                |
 | Effects        | Reflection, 3D rotation / extrusion, artistic effects                                          |
-| Charts         | Area, radar, doughnut, bubble, stock, combo, histogram, box plot, waterfall, treemap, sunburst |
+| Charts         | Stock, combo, histogram, box plot, waterfall, treemap, sunburst                                |
 | Chart details  | Data labels, axis titles / tick marks / grid lines, error bars, trendlines                     |
-| Text           | Vertical text, individual text effects (shadow/glow), text outline, text columns               |
+| Text           | Individual text effects (shadow/glow), text columns                                            |
 | Tables         | Table style template application, diagonal borders                                             |
 | Shapes         | Shape operations (Union/Subtract/Intersect/Fragment)                                           |
 | Multimedia     | Embedded video / audio                                                                         |