Package Exports

@yumdocs/yumdocs
@yumdocs/yumdocs/dist/index.cjs.js
@yumdocs/yumdocs/dist/index.esm.js
@yumdocs/yumdocs/dist/index.umd.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@yumdocs/yumdocs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Yumdocs

Yumdocs is a template engine for Office documents, including Word, PowerPoint and Excel, in JavaScript environments. It merges documents with data, executing statements and expressions found in tags.

Documentation

Yumdocs is fully documented at https://dev.yumdocs.com.

License and Copyright

This project is MIT Licensed like its 3rd party components:

Quick Start

Check https://dev.yumdocs.com for browser instructions. The following targets nodeJS.

Prerequisites

Download and install nodeJS v16+ from https://nodejs.org/.

Installation

Create a project directory, make it your working directory, and run from a terminal window:

npm init -y
npm i @yumdocs/yumdocs

Getting started

Create a Word document named input.docx, type {{field}} and save it in the project directory.
In the same project directory, create a file named index.mjs and copy-paste:

import {YumTemplate} from '@yumdocs/yumdocs';
const t = new YumTemplate();
await t.load('./input.docx');
await t.render({field: 'Anything you see fit'});
await t.saveAs('./output.docx');

Open a terminal window in this project directory and run node index.mjs.
output.docx has been generated and the {{field}} placeholder has been replaced with Anything you see fit.