@docx-editor.dev/docx-to-markdown 2.20.0 → 2.21.0

package/README.md

@@ -1,15 +1,12 @@
 # DOCX to Markdown
 
-Use `@docx-editor.dev/docx-to-markdown` to convert DOCX files to Markdown.
-The result includes the document body, individual pages, and separate headers, footers, comments, and tracked changes.
+Use `@docx-editor.dev/docx-to-markdown` to convert DOCX files to Markdown. The result includes the document body, individual pages, and separate headers, footers, comments, and tracked changes.
 
-[Try the DOCX to Markdown demo](https://docx-to-markdown.docx-editor.dev/) or read the
-[Markdown export guide](https://www.docx-editor.dev/docs/2.x/export/markdown).
+[Try the DOCX to Markdown demo](https://docx-to-markdown.docx-editor.dev/) or read the [Markdown export guide](https://www.docx-editor.dev/docs/2.x/export/markdown).
 
 ## Before you begin
 
-For Node.js, use version 20.16.0 or later in the 20.x release line, or version 22.3.0 or later.
-The converter requires WebAssembly and uses bundled fonts by default.
+For Node.js, use version 20.16.0 or later in the 20.x release line, or version 22.3.0 or later. The converter requires WebAssembly and uses bundled fonts by default.
 
 ## Install the package
 
@@ -40,18 +37,11 @@ Set `images: true` to include image links and extracted bytes:
 const result = await exportMarkdown(docxBytes, { images: true });
 ```
 
-`result.media` contains image bytes and their page occurrences.
-See [image workflows](docs/images.md) to save a folder, download a ZIP, or return hosted URLs.
+`result.media` contains image bytes and their page occurrences. See [image workflows](docs/images.md) to save a folder, download a ZIP, or return hosted URLs.
 
 ### Preserve displayed image sizes
 
-Use `images: { syntax: 'html' }` to include each image's displayed width and height in generated `<img>` tags.
-Dimensions use whole CSS pixels. Configure your Markdown renderer to allow sanitized HTML and retain `width` and `height`.
-The default `images: true` uses standard Markdown image syntax, which has no size attributes.
-For custom previews, use each occurrence's `displayWidthPx` and `displayHeightPx`.
-Asset `pixelWidth` and `pixelHeight` describe the image file's dimensions.
-Crop, rotation, and floating text wrapping are not reproduced.
-See [displayed image sizes and custom previews](docs/images.md#preserve-displayed-image-sizes).
+Use `images: { syntax: 'html' }` to include each image's displayed width and height in generated `<img>` tags. Dimensions use whole CSS pixels. Configure your Markdown renderer to allow sanitized HTML and retain `width` and `height`. The default `images: true` uses standard Markdown image syntax, which has no size attributes. For custom previews, use each occurrence's `displayWidthPx` and `displayHeightPx`. Asset `pixelWidth` and `pixelHeight` describe the image file's dimensions. Crop, rotation, and floating text wrapping are not reproduced. See [displayed image sizes and custom previews](docs/images.md#preserve-displayed-image-sizes).
 
 ## Read page output
 
@@ -82,8 +72,7 @@ For Next.js, use the Node.js runtime and [server package configuration](docs/int
 
 Page breaks depend on fonts, document features, and revision mode; they can differ from Microsoft Word. Store the document version with page citations. `result.warnings` reports omitted content and font problems. Images are omitted unless enabled. See [output limits](docs/api.md#markdown-limitations) before using the output as a complete transcription.
 
-The package uses the Apache 2.0 license, including comment and tracked-change extraction.
-Bundled fonts retain their own open-source licenses.
+The package uses the Apache 2.0 license, including comment and tracked-change extraction. Bundled fonts retain their own open-source licenses.
 
 ## Next steps
 

package/docs/api.md

@@ -1,7 +1,6 @@
 # DOCX to Markdown API reference
 
-Use this reference to choose an export function, configure conversion, and inspect the result.
-For installation and a first export, see the [package quickstart](../README.md).
+Use this reference to choose an export function, configure conversion, and inspect the result. For installation and a first export, see the [package quickstart](../README.md).
 
 ## Public interface
 
@@ -157,12 +156,7 @@ Tracked changes also participate in layout through `displayMode`: `all-markup` (
 
 Enable `images: true` for relative image links and `result.media` bytes. Use `{ images: { resolveUrl, maxTotalBytes } }` for custom delivery. The default extracted-byte limit is 64 MiB; image extraction is opt-in. `exportMarkdownFrom(session, options)` accepts the same image options and an abort signal.
 
-Set `images: { syntax: 'html' }` to emit `<img>` tags with each occurrence's displayed width and height in whole CSS pixels.
-The default `syntax: 'markdown'` emits standard image links without size attributes.
-Your renderer must support sanitized HTML and retain `width` and `height`.
-Occurrences expose exact `displayWidthPx`, `displayHeightPx`, and `kind` (`inline` or `anchored`).
-Asset `pixelWidth` and `pixelHeight` describe the image bytes, not their displayed size.
-Crop, rotation, and floating text wrapping are not reproduced.
+Set `images: { syntax: 'html' }` to emit `<img>` tags with each occurrence's displayed width and height in whole CSS pixels. The default `syntax: 'markdown'` emits standard image links without size attributes. Your renderer must support sanitized HTML and retain `width` and `height`. Occurrences expose exact `displayWidthPx`, `displayHeightPx`, and `kind` (`inline` or `anchored`). Asset `pixelWidth` and `pixelHeight` describe the image bytes, not their displayed size. Crop, rotation, and floating text wrapping are not reproduced.
 
 `createMarkdownZip(result)` and `toMarkdownJSON(result)` are exported from the main package. `writeMarkdownBundle(result, { directory })` comes from `@docx-editor.dev/docx-to-markdown/node`. See [image APIs, errors, ownership, and runnable workflows](images.md).
 

package/docs/images.md

@@ -1,7 +1,6 @@
 # Include images in Markdown exports
 
-Before you begin, [install the converter](../README.md#install-the-package).
-Set `images: true` to include image links and extracted bytes. For this Node.js example, save the code as `convert.mjs`, place `document.docx` beside it, and run `node convert.mjs`:
+Before you begin, [install the converter](../README.md#install-the-package). Set `images: true` to include image links and extracted bytes. For this Node.js example, save the code as `convert.mjs`, place `document.docx` beside it, and run `node convert.mjs`:
 
 ```ts
 import { readFile } from 'node:fs/promises';
@@ -15,19 +14,13 @@ console.log(result.media); // Unique bytes, paths, URLs, dimensions, and occurre
 
 `images: true` and `images: {}` use relative URLs. If you omit `images`, the result contains no image links and returns `media: []`.
 
-Each image contains its ID, path, URL, MIME type, bytes, intrinsic dimensions, and occurrences.
-The ID is a hexadecimal SHA-256 digest without the `sha256:` prefix. MIME types and extensions describe the exported bytes, including converted images.
+Each image contains its ID, path, URL, MIME type, bytes, intrinsic dimensions, and occurrences. The ID is a hexadecimal SHA-256 digest without the `sha256:` prefix. MIME types and extensions describe the exported bytes, including converted images.
 
-Each occurrence records its page, story, source position, displayed dimensions, drawing kind, and alternative text.
-Repeated uses of identical bytes share one asset with separate occurrences. Source offsets use UTF-16 code units.
-Keep the document version with stored citations: occurrence and page identifiers belong to that export snapshot.
-See the [image types](https://github.com/eigenpal/docx-editor/blob/main/packages/docx-to-markdown/src/media-types.ts) for all returned fields.
+Each occurrence records its page, story, source position, displayed dimensions, drawing kind, and alternative text. Repeated uses of identical bytes share one asset with separate occurrences. Source offsets use UTF-16 code units. Keep the document version with stored citations: occurrence and page identifiers belong to that export snapshot. See the [image types](https://github.com/eigenpal/docx-editor/blob/main/packages/docx-to-markdown/src/media-types.ts) for all returned fields.
 
 ## Preserve displayed image sizes
 
-An image file's `pixelWidth` and `pixelHeight` describe its intrinsic pixels. Word can display the same file at different sizes.
-Use each occurrence's `displayWidthPx` and `displayHeightPx` for the document's displayed size, in CSS pixels at 96 pixels per inch.
-These values retain fractional pixels. `kind` distinguishes inline and anchored drawings.
+An image file's `pixelWidth` and `pixelHeight` describe its intrinsic pixels. Word can display the same file at different sizes. Use each occurrence's `displayWidthPx` and `displayHeightPx` for the document's displayed size, in CSS pixels at 96 pixels per inch. These values retain fractional pixels. `kind` distinguishes inline and anchored drawings.
 
 Standard Markdown image syntax has no width or height attributes. To carry each occurrence's size into your Markdown renderer, replace the conversion call in the first example with:
 
@@ -38,14 +31,9 @@ const result = await exportMarkdown(docxBytes, {
 // <img src="media/<digest>.png" alt="Banner" width="300" height="80">
 ```
 
-The converter escapes HTML attributes and rounds the display dimensions to whole CSS pixels. Extents smaller than half a pixel round to zero.
-This option works with local folders, ZIP downloads, and `resolveUrl` for server storage.
-The default `syntax: 'markdown'` keeps standard image links without dimensions.
-Both options return full occurrence metadata.
+The converter escapes HTML attributes and rounds the display dimensions to whole CSS pixels. Extents smaller than half a pixel round to zero. This option works with local folders, ZIP downloads, and `resolveUrl` for server storage. The default `syntax: 'markdown'` keeps standard image links without dimensions. Both options return full occurrence metadata.
 
-Configure your renderer to parse HTML, sanitize it, and retain `img` attributes `src`, `alt`, `width`, and `height`.
-For example, [`react-markdown`](https://github.com/remarkjs/react-markdown#appendix-a-html-in-markdown) supports `rehype-raw` followed by [`rehype-sanitize`](https://github.com/rehypejs/rehype-sanitize); the default sanitizer retains these attributes.
-If your renderer disables HTML or removes size attributes, use the metadata in a custom preview.
+Configure your renderer to parse HTML, sanitize it, and retain `img` attributes `src`, `alt`, `width`, and `height`. For example, [`react-markdown`](https://github.com/remarkjs/react-markdown#appendix-a-html-in-markdown) supports `rehype-raw` followed by [`rehype-sanitize`](https://github.com/rehypejs/rehype-sanitize); the default sanitizer retains these attributes. If your renderer disables HTML or removes size attributes, use the metadata in a custom preview.
 
 For a custom React preview, pass the selected occurrence and its asset's trusted preview URL:
 
@@ -78,17 +66,11 @@ function ImagePreview({
 }
 ```
 
-The explicit aspect ratio preserves Word's displayed proportions when the image shrinks, even if they differ from its intrinsic proportions.
-Use the same styles in a custom Markdown image component, with `width` and `height` from the generated HTML.
-Resolve `src` through your known asset URLs, as shown in the browser example.
+The explicit aspect ratio preserves Word's displayed proportions when the image shrinks, even if they differ from its intrinsic proportions. Use the same styles in a custom Markdown image component, with `width` and `height` from the generated HTML. Resolve `src` through your known asset URLs, as shown in the browser example.
 
-Do not use an asset's first occurrence to size every image with the same URL.
-Occurrences describe physical layout and include repeated headers; their order is not a Markdown image index.
-Use HTML syntax to attach the correct dimensions directly to each rendered image.
-For a preview built from occurrence metadata, identify the occurrence by its page, story, part, and drawing node.
+Do not use an asset's first occurrence to size every image with the same URL. Occurrences describe physical layout and include repeated headers; their order is not a Markdown image index. Use HTML syntax to attach the correct dimensions directly to each rendered image. For a preview built from occurrence metadata, identify the occurrence by its page, story, part, and drawing node.
 
-Displayed dimensions describe the drawing's extent before crop and rotation. They do not reproduce cropping, rotation, effects, alignment, or floating text wrapping.
-Anchored images appear at their source paragraph positions in Markdown.
+Displayed dimensions describe the drawing's extent before crop and rotation. They do not reproduce cropping, rotation, effects, alignment, or floating text wrapping. Anchored images appear at their source paragraph positions in Markdown.
 
 ## Save a local folder
 
@@ -103,9 +85,7 @@ const result = await exportMarkdown(await readFile('input.docx'), { images: true
 await writeMarkdownBundle(result, { directory: './output' });
 ```
 
-The helper writes `document.md`, `document.json`, and `media/`.
-The parent directory must exist, and the output directory must be new or empty. Existing files are not overwritten.
-Files use `0o600` permissions where supported. JSON includes page, review, and image metadata without image bytes.
+The helper writes `document.md`, `document.json`, and `media/`. The parent directory must exist, and the output directory must be new or empty. Existing files are not overwritten. Files use `0o600` permissions where supported. JSON includes page, review, and image metadata without image bytes.
 
 ## Save a ZIP file
 
@@ -123,9 +103,7 @@ The ZIP includes `document.md`, `document.json`, and `media/`. Keep generated re
 
 ## Convert and download in the browser
 
-Configure your bundler to serve the package's font and WebAssembly assets.
-For a working configuration, see the [browser demo](https://github.com/eigenpal/docx-editor/tree/main/examples/docx-to-markdown).
-Image extraction runs in the browser without a server or storage service.
+Configure your bundler to serve the package's font and WebAssembly assets. For a working configuration, see the [browser demo](https://github.com/eigenpal/docx-editor/tree/main/examples/docx-to-markdown). Image extraction runs in the browser without a server or storage service.
 
 ```ts
 import { exportMarkdown, createMarkdownZip } from '@docx-editor.dev/docx-to-markdown';

package/docs/integrations.md

@@ -1,7 +1,6 @@
 # Integrate DOCX to Markdown
 
-Before you begin, [install the converter and check the runtime requirements](../README.md#before-you-begin).
-Use `result.markdown` for text and `result.pages` for page citations. See [image delivery](images.md) for browser ZIP downloads, local folders, and server URLs with JSON metadata.
+Before you begin, [install the converter and check the runtime requirements](../README.md#before-you-begin). Use `result.markdown` for text and `result.pages` for page citations. See [image delivery](images.md) for browser ZIP downloads, local folders, and server URLs with JSON metadata.
 
 ## LangChain
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx-editor.dev/docx-to-markdown",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -46,10 +46,10 @@
     "check:consumer": "node ../../scripts/check-markdown-media-consumer.mjs"
   },
   "peerDependencies": {
-    "@docx-editor.dev/core": "~2.20.0"
+    "@docx-editor.dev/core": "~2.21.0"
   },
   "dependencies": {
-    "@docx-editor.dev/fonts": "~2.20.0",
+    "@docx-editor.dev/fonts": "~2.21.0",
     "fflate": "^0.8.2"
   },
   "devDependencies": {