docxtemplater CLI (with Image Module Free)

This fork of docxtemplater CLI includes the support for docxtemplater-image-module-free. This module is different from the module open-docxtemplater-image-module, which does not work now. Moreover, this cli also includes the support for the rendering of some basic html code. This code is taken from pwndoc and the syntax to use it is the same used by pwndoc itself and is documented here.

Installation

The package below includes a copy of docxtemplater and docxtemplater-image-module-free.
If you want to install with npm:

npm install -g https://github.com/cybersecsi/docxtemplater-cli-image-module-free.git

To remove it:

npm uninstall -g docxtemplater-cli-image-module-free

You can also use the binary:

Try it out

Browse to folder 'examples' and run the following in your console

docxtemplater input.pptx data.json output.pptx

data.json file structure

This is a simple JSON file. Assuming we are working on the template 'input.pptx' provided with this package in 'examples' folder, we write below JSON to replace tags in the template by their respective value.

{
    "first_name": "John",
    "last_name": "Doe",
    "description": "He is awesome",
    "phone": "+4412345678",
    "picture": "johndoe.png"
}

As you can see we have included a picture of John Doe (johndoe.png). For this picture to be correctly rendered in the output, we must explicitly activate the Image Module Free docxtemplater-image-module-free. Note that all images must be under the directory 'imageDir'.

{
    "first_name": "John",
    "last_name": "Doe",
    "description": "He is awesome",
    "phone": "+4412345678",
    "picture": "johndoe.png",
    "config": {
      "modules": ["docxtemplater-image-module-free"],
      "imageDir": "."
    }
}

If you want to render an html field on the document, that field must end with "_html". In this example the field "description" becomes "description_html" and it is the name that must have in the template document as well.

{
    "first_name": "John",
    "last_name": "Doe",
    "description_html": "<p>He is awesome</p>",
    "phone": "+4412345678",
    "picture": "johndoe.png",
    "config": {
      "modules": ["docxtemplater-image-module-free"],
      "imageDir": "."
    }
}

Template tags

More on how to write your templates in docxtemplater documentation.

Release guide

To create a new release:

1. Login and install gh
2. Install pkg (npm install -g pkg)
3. Update the version of the package with npm
4. Run make release to build the packages and upload a new release.