@ooxml-tools/render

Render Office Open XML files in native applications (word, pages, etc...)

Support for rendering

• .docx — WordprocessingML
• .xlsx — SpreadsheetML
• .pptx — PresentationML

This tool can be used as a part of visual regression for various editors

Support

• .docx
  • msword — ✅ macos / 🔜 win
  • pages — ✅ macos
  • libreoffice — ✅ macos / 🔜 linux / 🔜 win
  • googledocs — 🔜
  • onedrive — 🔜
• .pptx
  • powerpoint — 🔜 macos / 🔜 win
  • keynote — ✅ macos
  • libreoffice — ✅ macos / 🔜 linux / 🔜 win
  • googledocs — 🔜
  • onedrive — 🔜
• .xlsx
  • excel — 🔜 macos / 🔜 win
  • numbers — ✅ macos
  • libreoffice — ✅ macos / 🔜 linux / 🔜 win
  • googledocs — 🔜
  • onedrive — 🔜

Requirements

You must have the apps you wish to use above installed on your machine.

We use imagemagick for converting PDFs created from the various editors. So you must either have the imagemagick CLI installed locally or docker/docker-compose installed on your machine.

Usage

import render from "@ooxml-tools/render";

const input = await readFile("./test.docx");
const outputDir = "./output/";
await render(input, ["msword"], { outputDir });

CLI

npx @ooxml-tools/render --help
# ooxml-render <command> [args]
#
# Commands:
#   render <filepath>   render files
#   support <filepath>  list supported apps for <filepath>
#
# Options:
#   --version  Show version number                                       [boolean]
#   --help     Show help                                                 [boolean]

License

MIT