node package manager

docxtemplater

.docx generator working with templates and data (like Mustache)

docxtemplater

docxtemplater is a library to generate docx/pptx documents from a docx/pptx template. It can replace {placeholders} with data and also supports loops and conditions. The templates can be edited by non-programmers, eg for example your clients.

Note: The CLI will soon be moved to another repository : keep posted on https://github.com/open-xml-templating/docxtemplater-cli

Demo Site

Installation: npm install docxtemplater

var fs = require('fs');
var Docxtemplater = require('docxtemplater');
 
//Load the docx file as a binary 
var content = fs
    .readFileSync(__dirname + "/input.docx", "binary");
 
var doc = new Docxtemplater(content);
 
//set the templateVariables 
doc.setData({
    "first_name":"Hipp",
    "last_name":"Edgar",
    "phone":"0652455478",
    "description":"New Website"
});
 
//apply them (replace all occurences of {first_name} by Hipp, ...) 
doc.render();
 
var buf = doc.getZip()
             .generate({type:"nodebuffer"});
 
fs.writeFileSync(__dirname+"/output.docx",buf);

You can download input.docx and put it in the same folder than your script.

You can directly download built versions from github : https://github.com/open-xml-templating/docxtemplater-build/tree/master/build

Thanks to pykiss, it's now possible to install docxtemplater with bower: This in an unofficial method to install docxtemplater in the browser

bower install --save docxtemplater-pykiss

I recommend you to use the npm scripts I wrote (which can be found in the package.json).

git clone git@github.com:edi9999/docxtemplater.git && cd docxtemplater
# git checkout v2.0.0 # Optional
npm install
npm run compile
# Optionally :
# npm run browserify
# npm run uglify:lib

The Docxgen will be exported to window.Docxgen for easy usage (on some systems, it might export it in window.docxgen (see https://github.com/edi9999/docxtemplater/issues/118))

Your version of docxtemplater will be in /build (minified and non minified options) and already include all dependencies

Create the following html

<html>
    <script src="build/docxtemplater.js"></script> 
    <script src="vendor/FileSaver.min.js"></script> 
    <script src="vendor/jszip-utils.js"></script> 
    <!--
    Mandatory in IE 6, 7, 8 and 9.
    -->
    <!--[if IE]>
        <script type="text/javascript" src="examples/vendor/jszip-utils-ie.js"></script>
    <![endif]-->
    <script>
    var loadFile=function(url,callback){
        JSZipUtils.getBinaryContent(url,callback);
    }
    loadFile("examples/tagExample.docx",function(err,content){
        if (err) { throw e};
        doc=new Docxtemplater(content);
        doc.setData( {"first_name":"Hipp",
            "last_name":"Edgar",
            "phone":"0652455478",
            "description":"New Website"
            }
        ) //set the templateVariables
        doc.render() //apply them (replace all occurences of {first_name} by Hipp, ...)
        out=doc.getZip().generate({type:"blob"}) //Output the document using Data-URI
        saveAs(out,"output.docx")
    })
    </script> 
</html>

The full documentation of the latest version can be found on read the docs.

See upgrade.md for information about how to migrate from older versions.

They are a few similar libraries that work with docx, here’s a list of those I know a bit about:

  • docx4j :JAVA, this is probably the biggest docx library out there. They is no built in templating engine, but you can generate your docx yourself programmatically
  • docx.js: Javascript in the browser, you can create (not modify) your docx from scratch, but only do very simple things such as adding non formatted text
  • xlsx-templater : its working quite well, does the same as here but for xlsx

Modules

Functionality can be added with modules. They is yet no doc for the modules because it is not completely mature yet, but you can open an issue if you have any question about it.

Here is the list of existing modules:

Professional Support

I can give your company support for installing, extending, answering support questions, or maintainning your app that runs docxtemplater. You can find my email address on my profile