Giter Club home page Giter Club logo

docxtemplater's Introduction

docxtemplater

Build Status Download count Current tag CDNJS version size gzip size

Browser matrix

docxtemplater logo

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, for example your clients.

Features

Demo Site

Quickstart

Documentation

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

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

Similar libraries

There 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. There 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. Documentation is missing.
  • redocx : Create Docx document from scratch, using JSX syntax, last commit on December 2018.
  • officegen : works only server side for the moment.

Modules

Functionality can be added with modules. Here is the list of existing modules:

PRO Modules developped by docxtemplater core team :

  • Image module to add a given image with the syntax: {%image}.
  • Html Module to insert formatted text in a docx document.
  • Html-Pptx Module to insert formatted text in a pptx document.
  • Slides Module to create multiple slides dynamically.
  • Subtemplate Module to include an external docx file inside a given docx file.
  • Subsection Module to include subsections (headers/footers) from an other document.
  • Subtemplate-pptx Module to include an external pptx file inside a given pptx file.
  • Word-Run Module to include raw runs (<w:r>) inside the document. This makes it possible to include styled text without having to remove the enclosing paragraph like in the {@rawXml} tag.
  • QrCode Module to replace an image, keeping any existing properties.
  • Error Location Module to show the errors in the template with comments inside the template.
  • Table Module to create tables from two dimensional data.
  • Meta Module to make a document readonly, add a text watermark or update the margins.
  • Styling Module restyle a paragraph, a cell or a table depending on some data.
  • XLSX Module to be able to do templating on Excel files (xlsx extension), also with loops and conditions.
  • Footnotes Module to be able to add footnotes to a document.
  • Paragraph Placeholder Module to simplify conditions that should show or hide a given paragraph.

User-contributed modules :

  • Chart Module using the syntax: {$chart} , user contributed (compatible with v2 only)
  • Hyperlink module using the syntax: {^link}, (compatible with v2 only)

docxtemplater's People

Contributors

aarbel avatar aaronbaker avatar aymericbouzy avatar balazsbohonyi avatar cheapsteak avatar dderg avatar edi9999 avatar extend1994 avatar fponticelli avatar frapontillo avatar gitter-badger avatar harish-aka-shivi avatar kohakade avatar marti4ka avatar maxrcd avatar netei avatar nrekretep avatar p0rt3rh avatar paultopia avatar sgrignard avatar shadab14meb346 avatar sujith3g avatar tabacha avatar tamagokun avatar tdonia avatar themercee avatar totalwar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.