Version bump

Add workflow and issue template

.editorconfig

@@ -7,6 +7,7 @@ indent_style = space
 indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
+end_of_line = lf
 
 [*.md]
 max_line_length = off

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: dolanmiu
+patreon: dolanmiu
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+# Thank you for raising an issue to `docx`
+
+Please do not raise an issue unless it is an **issue**.
+
+-   Is your issue a feature request? Are you giving ideas to the community? Are you asking for help? Please raise a ticket in the `Discussions` section:
+
+    https://github.com/dolanmiu/docx/discussions
+
+-   Is your issue a previously asked? Please respond to that thread instead

.github/workflows/default.yml

@@ -0,0 +1,134 @@
+name: Default
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Build
+              run: npm run build
+            - name: Archive Production Artifact
+              uses: actions/upload-artifact@master
+              with:
+                  name: build
+                  path: build
+    test:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Test
+              run: npm run test.coverage
+    lint:
+        name: Lint
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Lint
+              run: npm run lint
+    prettier:
+        name: Prettier
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Prettier
+              run: npm run style
+    demos:
+        name: Run Demos
+        needs: [build]
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Download Artifact
+              uses: actions/download-artifact@master
+              with:
+                  name: build
+                  path: build
+            - name: Run demos
+              run: |
+                  npm run ts-node -- ./demo/1-basic.ts
+                  npm run ts-node -- ./demo/2-declaritive-styles.ts
+                  npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
+                  npm run ts-node -- ./demo/4-basic-table.ts
+                  npm run ts-node -- ./demo/5-images.ts
+                  npm run ts-node -- ./demo/6-page-borders.ts
+                  npm run ts-node -- ./demo/7-landscape.ts
+                  npm run ts-node -- ./demo/8-header-footer.ts
+                  npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
+                  npm run ts-node -- ./demo/10-my-cv.ts
+                  npm run ts-node -- ./demo/11-declaritive-styles-2.ts
+                  npm run ts-node -- ./demo/12-scaling-images.ts
+                  npm run ts-node -- ./demo/13-xml-styles.ts
+                  npm run ts-node -- ./demo/14-page-numbers.ts
+                  npm run ts-node -- ./demo/15-page-break-before.ts
+                  npm run ts-node -- ./demo/16-multiple-sections.ts
+                  npm run ts-node -- ./demo/17-footnotes.ts
+                  npm run ts-node -- ./demo/18-image-from-buffer.ts
+                  npm run ts-node -- ./demo/19-export-to-base64.ts
+                  npm run ts-node -- ./demo/20-table-cell-borders.ts
+                  npm run ts-node -- ./demo/21-bookmarks.ts
+                  npm run ts-node -- ./demo/22-right-to-left-text.ts
+                  npm run ts-node -- ./demo/23-base64-images.ts
+                  npm run ts-node -- ./demo/24-images-to-table-cell.ts
+                  npm run ts-node -- ./demo/25-table-xml-styles.ts
+                  npm run ts-node -- ./demo/26-paragraph-borders.ts
+                  npm run ts-node -- ./demo/27-declaritive-styles-3.ts
+                  npm run ts-node -- ./demo/28-table-of-contents.ts
+                  npm run ts-node -- ./demo/29-numbered-lists.ts
+                  npm run ts-node -- ./demo/30-template-document.ts
+                  npm run ts-node -- ./demo/31-tables.ts
+                  npm run ts-node -- ./demo/32-merge-and-shade-table-cells.ts
+                  npm run ts-node -- ./demo/33-sequential-captions.ts
+                  npm run ts-node -- ./demo/34-floating-tables.ts
+                  npm run ts-node -- ./demo/35-hyperlinks.ts
+                  npm run ts-node -- ./demo/36-image-to-table-cell.ts
+                  npm run ts-node -- ./demo/37-images-to-header-and-footer.ts
+                  npm run ts-node -- ./demo/38-text-wrapping.ts
+                  npm run ts-node -- ./demo/39-page-numbers.ts
+                  npm run ts-node -- ./demo/40-line-numbers.ts
+                  npm run ts-node -- ./demo/41-merge-table-cells-2.ts
+                  npm run ts-node -- ./demo/42-restart-page-numbers.ts
+                  npm run ts-node -- ./demo/43-images-to-table-cell-2.ts
+                  npm run ts-node -- ./demo/44-multiple-columns.ts
+                  npm run ts-node -- ./demo/45-highlighting-text.ts
+                  npm run ts-node -- ./demo/46-shading-text.ts
+                  npm run ts-node -- ./demo/47-number-of-total-pages-section.ts
+                  npm run ts-node -- ./demo/48-vertical-align.ts
+                  npm run ts-node -- ./demo/49-table-borders.ts
+                  npm run ts-node -- ./demo/50-readme-demo.ts
+                  npm run ts-node -- ./demo/51-character-styles.ts
+                  npm run ts-node -- ./demo/52-japanese.ts
+                  npm run ts-node -- ./demo/53-chinese.ts
+                  npm run ts-node -- ./demo/54-custom-properties.ts
+                  npm run ts-node -- ./demo/55-math.ts
+                  npm run ts-node -- ./demo/56-background-color.ts
+                  npm run ts-node -- ./demo/57-add-parent-numbered-lists.ts
+                  npm run ts-node -- ./demo/58-section-types.ts
+                  npm run ts-node -- ./demo/59-header-footer-margins.ts
+                  npm run ts-node -- ./demo/60-track-revisions.ts
+                  npm run ts-node -- ./demo/61-text-frame.ts
+                  npm run ts-node -- ./demo/62-paragraph-spacing.ts
+                  npm run ts-node -- ./demo/63-odd-even-header-footer.ts

.gitignore

@@ -36,6 +36,10 @@ node_modules
 build
 build-tests
 
+# Documentation
+docs/api/
+docs/.nojekyll
+
 # VSCode
 .vscode/*
 !.vscode/settings.json
@@ -44,5 +48,17 @@ build-tests
 !.vscode/extensions.json
 .history
 
+# IntelliJ
+.idea
+
 # Lock files
-package-lock.json
+yarn.lock
+
+# Documents
+My Document.docx
+
+# Temporary folder
+tmp
+
+# nyc
+.nyc_output

.nvmrc

@@ -0,0 +1 @@
+v10

.nycrc

@@ -0,0 +1,26 @@
+{
+  "check-coverage": true,
+  "lines": 98.86,
+  "functions": 97.86,
+  "branches": 95.86,
+  "statements": 98.86,
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/**/*.spec.ts",
+    "src/import-dotx/import-dotx.ts"
+  ],
+  "reporter": [
+    "lcov",
+    "text",
+    "json"
+  ],
+  "extension": [
+    ".ts"
+  ],
+  "cache": true,
+  "all": true,
+  "instrument": false,
+  "sourceMap": true
+}

.prettierrc.yml

@@ -0,0 +1,5 @@
+trailingComma: all
+printWidth: 140
+tabWidth: 4
+arrowParens: always
+bracketSpacing: true

.travis.yml

@@ -1,25 +1,63 @@
 language: node_js
 node_js:
-  - "stable"
+  - 10
 install:
   - npm install
+  - npm install -g codecov
 script:
   - npm run lint
-  - npm test
+  - npm run test.coverage
   - npm run style
   - npm run build
-  - node ./demo/demo1.js
-  - node ./demo/demo2.js
-  - node ./demo/demo3.js
-  - node ./demo/demo4.js
-  - node ./demo/demo5.js
-  - node ./demo/demo6.js
-  - node ./demo/demo7.js
+  - npm run ts-node -- ./demo/1-basic.ts
+#   - npm run e2e "My Document.docx"
+  - npm run ts-node -- ./demo/2-declaritive-styles.ts
+  - npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
+  - npm run ts-node -- ./demo/4-basic-table.ts
+  - npm run ts-node -- ./demo/5-images.ts
+  - npm run ts-node -- ./demo/6-page-borders.ts
+  - npm run ts-node -- ./demo/7-landscape.ts
+  - npm run ts-node -- ./demo/8-header-footer.ts
+  - npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
+  - npm run ts-node -- ./demo/10-my-cv.ts
+#   - npm run e2e "My Document.docx"
+  - npm run ts-node -- ./demo/11-declaritive-styles-2.ts
+  - npm run ts-node -- ./demo/12-scaling-images.ts
+  - npm run ts-node -- ./demo/13-xml-styles.ts
+  - npm run ts-node -- ./demo/14-page-numbers.ts
+  - npm run ts-node -- ./demo/15-page-break-before.ts
+  - npm run ts-node -- ./demo/16-multiple-sections.ts
+  - npm run ts-node -- ./demo/17-footnotes.ts
+  - npm run ts-node -- ./demo/18-image-from-buffer.ts
+  - npm run ts-node -- ./demo/19-export-to-base64.ts
+  - npm run ts-node -- ./demo/20-table-cell-borders.ts
+  - npm run ts-node -- ./demo/21-bookmarks.ts
+  - npm run ts-node -- ./demo/22-right-to-left-text.ts
+  - npm run ts-node -- ./demo/23-base64-images.ts
+  - npm run ts-node -- ./demo/24-images-to-table-cell.ts
+#   - npm run ts-node -- ./demo/demo25.ts
+  - npm run ts-node -- ./demo/26-paragraph-borders.ts
+  - npm run ts-node -- ./demo/27-declaritive-styles-3.ts
+  - npm run ts-node -- ./demo/28-table-of-contents.ts
+  - npm run ts-node -- ./demo/29-numbered-lists.ts
+  - npm run ts-node -- ./demo/30-template-document.ts
+  - npm run ts-node -- ./demo/31-tables.ts
+  - npm run ts-node -- ./demo/32-merge-and-shade-table-cells.ts
+#   - npm run e2e "My Document.docx" // Need to fix
+  - npm run ts-node -- ./demo/33-sequential-captions.ts
+  - npm run ts-node -- ./demo/34-floating-tables.ts
 after_failure:
   - "cat /home/travis/builds/dolanmiu/docx/npm-debug.log"
 after_success:
-  - bash ./deploy-docs.sh
-env:
-  global:
-  - ENCRYPTION_LABEL: "ad385fa3b525"
-
+  - npm run typedoc
+  - echo "docx.js.org" > docs/.nojekyll
+  - echo "docx.js.org" > docs/CNAME
+  - codecov
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  local-dir: docs
+  on:
+    branch: master

.vscode/tasks.json

@@ -0,0 +1,24 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "typescript",
+            "tsconfig": "tsconfig.json",
+            "option": "watch",
+            "problemMatcher": [
+                "$tsc-watch"
+            ]
+        },
+        {
+            "type": "npm",
+            "script": "ts-node",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}

README.md

@@ -1,99 +1,123 @@
 <p align="center">
-    <img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
+    <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
 </p>
 
 <p align="center">
-    Generate .docx files with JS/TS very easily, written in TS.
+    Easily generate .docx files with JS/TS. Works for Node and on the Browser.
 </p>
 
------
+---
 
 [![NPM version][npm-image]][npm-url]
+[![Downloads per month][downloads-image]][downloads-url]
 [![Build Status][travis-image]][travis-url]
-[![Dependency Status][gemnasium-image]][gemnasium-url]
+[![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
+[![Dependency Status][daviddm-image]][daviddm-url]
 [![Known Vulnerabilities][snky-image]][snky-url]
 [![Chat on Gitter][gitter-image]][gitter-url]
-[![code style: prettier][prettier-image]][prettier-url]
+[![PRs Welcome][pr-image]][pr-url]
+[![codecov][codecov-image]][codecov-url]
 
-[![NPM](https://nodei.co/npm/docx.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/docx/)
+<p align="center">
+    <img src="https://i.imgur.com/tBO0XBR.png" alt="drawing"/>
+</p>
 
-# docx
+# Demo
 
-## Install
+## Browser
 
-```sh
-$ npm install --save docx
-```
+Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
 
-## Demo
+*   https://codepen.io/dolanmiu/pen/RwNeObg
+*   https://jsfiddle.net/dolanmiu/kqxrj35u/1/
 
-```sh
-$ npm run demo
-```
+Here is an example of `docx` working in `Angular`:
 
-will run the demo selector app in the `demo` folder. It will prompt you to select a demo number, which will run a demo from that folder.
+*   https://stackblitz.com/edit/angular-docx
 
-## Guide
+Here is an example of `docx` working in `React`:
 
-Please refer to [the Wiki](https://github.com/dolanmiu/docx/wiki) for details on how to use this library, examples and much more!
+*   https://stackblitz.com/edit/react-docx
+*   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
 
-Full documentation can be found here: [http://dolanmiu.github.io/docx](http://dolanmiu.github.io/docx)
+Here is an example of `docx` working in `Vue.js`:
 
-## Simple Usage
+*   https://stackblitz.com/edit/vuejs-docx
 
-```js
-// Used to create docx files
-var docx = require('docx');
+## Node
 
-// Create document
-var doc = new docx.Document();
+Press `endpoint` on the `RunKit` website:
 
-// Add some content in the document
-var paragraph = new docx.Paragraph("Some cool text here.");
-// Add more text into the paragraph if you wish
-paragraph.addRun(new docx.TextRun('Lorem Ipsum Foo Bar'));
-doc.addParagraph(paragraph);
+![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
 
-// Used to export the file into a .docx file
-var exporter = new docx.LocalPacker(doc);
+*   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
+*   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
+*   https://runkit.com/dolanmiu/docx-demo3 - Bullet points
+*   https://runkit.com/dolanmiu/docx-demo4 - Simple table
+*   https://runkit.com/dolanmiu/docx-demo5 - Images
+*   https://runkit.com/dolanmiu/docx-demo6 - Margins
+*   https://runkit.com/dolanmiu/docx-demo7 - Landscape
+*   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
+*   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
 
-// Or use the express packer to make the file downloadable.
-// res is express' Response object
-var exporter = new docx.ExpressPacker(doc, res);
+More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
-exporter.pack('My First Document');
-// If you want to export it as a .pdf file instead
-exporter.packPdf('My First Document');
+# How to use & Documentation
 
-// done! A file called 'My First Document.docx'
-// will be in your file system if you used LocalPacker
-// Or it will start downloading if you are using Express
-```
+Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!
 
-## Examples
-Check [the Wiki](https://github.com/dolanmiu/docx/wiki/Examples) for examples.
+# Examples
+
+Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
 
 # Contributing
 
-Read the contribution guidelines [here](https://github.com/dolanmiu/docx/wiki/Contributing-Guidelines).
+Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).
 
------
+# Used by
+
+[<img src="https://i.imgur.com/zy5qWmI.png" alt="drawing" height="50"/>](https://hfour.com/)
+[<img src="https://i.imgur.com/OYP5tgS.png" alt="drawing" height="50"/>](https://fuzzproductions.com/)
+[<img src="https://i.imgur.com/zUDMfZ3.png" alt="drawing" height="50"/>](https://www.mettzer.com/)
+[<img src="https://i.imgur.com/wtNB1uq.png" alt="drawing" height="50"/>](https://www.wisedoc.net/)
+[<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
+[<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
+[<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
+[<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
+[<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
+[<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
+[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing" />](https://www.arity.co/)
+[<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
+
+
+...and many more!
+
+---
+
+[![patreon][patreon-image]][patreon-url]
+[![browserstack][browserstack-image]][browserstack-url]
 
 Made with 💖
 
-Huge thanks to [@felipeochoa](https://github.com/felipeochoa) for awesome contributions to this project
-
 [npm-image]: https://badge.fury.io/js/docx.svg
 [npm-url]: https://npmjs.org/package/docx
+[downloads-image]: https://img.shields.io/npm/dm/docx.svg
+[downloads-url]: https://npmjs.org/package/docx
 [travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master
 [travis-url]: https://travis-ci.org/dolanmiu/docx
+[github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
+[github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
 [daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
 [daviddm-url]: https://david-dm.org/dolanmiu/docx
 [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
 [snky-url]: https://snyk.io/test/github/dolanmiu/docx
 [gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg
 [gitter-url]: https://gitter.im/docx-lib/Lobby
-[gemnasium-image]: https://gemnasium.com/badges/github.com/dolanmiu/docx.svg
-[gemnasium-url]: https://gemnasium.com/github.com/dolanmiu/docx
-[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
-[prettier-url]: https://github.com/prettier/prettier
+[pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
+[pr-url]: http://makeapullrequest.com
+[codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/dolanmiu/docx
+[patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png
+[patreon-url]: https://www.patreon.com/dolanmiu
+[browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
+[browserstack-url]: https://www.browserstack.com

demo/1-basic.ts

@@ -0,0 +1,31 @@
+// Simple example to add text to a document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/10-my-cv.ts

@@ -0,0 +1,353 @@
+// Generate a CV
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
+
+// tslint:disable:no-shadowed-variable
+
+const PHONE_NUMBER = "07534563401";
+const PROFILE_URL = "https://www.linkedin.com/in/dolan1";
+const EMAIL = "docx@com";
+
+const experiences = [
+    {
+        isCurrent: true,
+        summary: "Full-stack developer working with Angular and Java. Working for the iShares platform",
+        title: "Associate Software Developer",
+        startDate: {
+            month: 11,
+            year: 2017,
+        },
+        company: {
+            name: "BlackRock",
+        },
+    },
+    {
+        isCurrent: false,
+        summary:
+            "Full-stack developer working with Angular, Node and TypeScript. Working for the iShares platform. Emphasis on Dev-ops and developing the continous integration pipeline.",
+        title: "Software Developer",
+        endDate: {
+            month: 11,
+            year: 2017,
+        },
+        startDate: {
+            month: 10,
+            year: 2016,
+        },
+        company: {
+            name: "Torch Markets",
+        },
+    },
+    {
+        isCurrent: false,
+        summary:
+            "Used ASP.NET MVC 5 to produce a diversity data collection tool for the future of British television.\n\nUsed AngularJS and C# best practices. Technologies used include JavaScript, ASP.NET MVC 5, SQL, Oracle, SASS, Bootstrap, Grunt.",
+        title: "Software Developer",
+        endDate: {
+            month: 10,
+            year: 2016,
+        },
+        startDate: {
+            month: 3,
+            year: 2015,
+        },
+        company: {
+            name: "Soundmouse",
+        },
+    },
+    {
+        isCurrent: false,
+        summary:
+            "Develop web commerce platforms for various high profile clients.\n\nCreated a log analysis web application with the Play Framework in Java, incorporating Test Driven Development. It asynchronously uploads and processes large (2 GB) log files, and outputs meaningful results in context with the problem. \n\nAnalysis  and  development  of  the payment system infrastructure and user accounts section to be used by several clients of the company such as Waitrose, Tally Weijl, DJ Sports, Debenhams, Ann Summers, John Lewis and others.\n\nTechnologies used include WebSphere Commerce, Java, JavaScript and JSP.",
+        title: "Java Developer",
+        endDate: {
+            month: 10,
+            year: 2014,
+        },
+        startDate: {
+            month: 3,
+            year: 2013,
+        },
+        company: {
+            name: "Soundmouse",
+        },
+    },
+];
+
+const education = [
+    {
+        degree: "Master of Science (MSc)",
+        fieldOfStudy: "Computer Science",
+        notes:
+            "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithmics, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
+        schoolName: "University College London",
+        startDate: {
+            year: 2012,
+        },
+        endDate: {
+            year: 2013,
+        },
+    },
+    {
+        degree: "Bachelor of Engineering (BEng)",
+        fieldOfStudy: "Material Science and Engineering",
+        notes:
+            "Exam Results: 2:1, Dissertation: 1st Class with Distinction\n\nRelevant courses: C Programming, Mathematics and Business for Engineers.",
+        schoolName: "Imperial College London",
+        startDate: {
+            year: 2009,
+        },
+        endDate: {
+            year: 2012,
+        },
+    },
+];
+
+const skills = [
+    {
+        name: "Angular",
+    },
+    {
+        name: "TypeScript",
+    },
+    {
+        name: "JavaScript",
+    },
+    {
+        name: "NodeJS",
+    },
+];
+
+const achievements = [
+    {
+        issuer: "Oracle",
+        name: "Oracle Certified Expert",
+    },
+];
+
+class DocumentCreator {
+    // tslint:disable-next-line: typedef
+    public create([experiences, educations, skills, achivements]): Document {
+        const document = new Document({
+            sections: [
+                {
+                    children: [
+                        new Paragraph({
+                            text: "Dolan Miu",
+                            heading: HeadingLevel.TITLE,
+                        }),
+                        this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL),
+                        this.createHeading("Education"),
+                        ...educations
+                            .map((education) => {
+                                const arr: Paragraph[] = [];
+                                arr.push(
+                                    this.createInstitutionHeader(
+                                        education.schoolName,
+                                        `${education.startDate.year} - ${education.endDate.year}`,
+                                    ),
+                                );
+                                arr.push(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`));
+
+                                const bulletPoints = this.splitParagraphIntoBullets(education.notes);
+                                bulletPoints.forEach((bulletPoint) => {
+                                    arr.push(this.createBullet(bulletPoint));
+                                });
+
+                                return arr;
+                            })
+                            .reduce((prev, curr) => prev.concat(curr), []),
+                        this.createHeading("Experience"),
+                        ...experiences
+                            .map((position) => {
+                                const arr: Paragraph[] = [];
+
+                                arr.push(
+                                    this.createInstitutionHeader(
+                                        position.company.name,
+                                        this.createPositionDateText(position.startDate, position.endDate, position.isCurrent),
+                                    ),
+                                );
+                                arr.push(this.createRoleText(position.title));
+
+                                const bulletPoints = this.splitParagraphIntoBullets(position.summary);
+
+                                bulletPoints.forEach((bulletPoint) => {
+                                    arr.push(this.createBullet(bulletPoint));
+                                });
+
+                                return arr;
+                            })
+                            .reduce((prev, curr) => prev.concat(curr), []),
+                        this.createHeading("Skills, Achievements and Interests"),
+                        this.createSubHeading("Skills"),
+                        this.createSkillList(skills),
+                        this.createSubHeading("Achievements"),
+                        ...this.createAchivementsList(achivements),
+                        this.createSubHeading("Interests"),
+                        this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."),
+                        this.createHeading("References"),
+                        new Paragraph(
+                            "Dr. Dean Mohamedally Director of Postgraduate Studies Department of Computer Science, University College London Malet Place, Bloomsbury, London WC1E d.mohamedally@ucl.ac.uk",
+                        ),
+                        new Paragraph("More references upon request"),
+                        new Paragraph({
+                            text:
+                                "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.",
+                            alignment: AlignmentType.CENTER,
+                        }),
+                    ],
+                },
+            ],
+        });
+
+        return document;
+    }
+
+    public createContactInfo(phoneNumber: string, profileUrl: string, email: string): Paragraph {
+        return new Paragraph({
+            alignment: AlignmentType.CENTER,
+            children: [
+                new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`),
+                new TextRun({
+                    text: "Address: 58 Elm Avenue, Kent ME4 6ER, UK",
+                    break: 1,
+                }),
+            ],
+        });
+    }
+
+    public createHeading(text: string): Paragraph {
+        return new Paragraph({
+            text: text,
+            heading: HeadingLevel.HEADING_1,
+            thematicBreak: true,
+        });
+    }
+
+    public createSubHeading(text: string): Paragraph {
+        return new Paragraph({
+            text: text,
+            heading: HeadingLevel.HEADING_2,
+        });
+    }
+
+    public createInstitutionHeader(institutionName: string, dateText: string): Paragraph {
+        return new Paragraph({
+            tabStops: [
+                {
+                    type: TabStopType.RIGHT,
+                    position: TabStopPosition.MAX,
+                },
+            ],
+            children: [
+                new TextRun({
+                    text: institutionName,
+                    bold: true,
+                }),
+                new TextRun({
+                    text: `\t${dateText}`,
+                    bold: true,
+                }),
+            ],
+        });
+    }
+
+    public createRoleText(roleText: string): Paragraph {
+        return new Paragraph({
+            children: [
+                new TextRun({
+                    text: roleText,
+                    italics: true,
+                }),
+            ],
+        });
+    }
+
+    public createBullet(text: string): Paragraph {
+        return new Paragraph({
+            text: text,
+            bullet: {
+                level: 0,
+            },
+        });
+    }
+
+    // tslint:disable-next-line:no-any
+    public createSkillList(skills: any[]): Paragraph {
+        return new Paragraph({
+            children: [new TextRun(skills.map((skill) => skill.name).join(", ") + ".")],
+        });
+    }
+
+    // tslint:disable-next-line:no-any
+    public createAchivementsList(achivements: any[]): Paragraph[] {
+        return achivements.map(
+            (achievement) =>
+                new Paragraph({
+                    text: achievement.name,
+                    bullet: {
+                        level: 0,
+                    },
+                }),
+        );
+    }
+
+    public createInterests(interests: string): Paragraph {
+        return new Paragraph({
+            children: [new TextRun(interests)],
+        });
+    }
+
+    public splitParagraphIntoBullets(text: string): string[] {
+        return text.split("\n\n");
+    }
+
+    // tslint:disable-next-line:no-any
+    public createPositionDateText(startDate: any, endDate: any, isCurrent: boolean): string {
+        const startDateText = this.getMonthFromInt(startDate.month) + ". " + startDate.year;
+        const endDateText = isCurrent ? "Present" : `${this.getMonthFromInt(endDate.month)}. ${endDate.year}`;
+
+        return `${startDateText} - ${endDateText}`;
+    }
+
+    public getMonthFromInt(value: number): string {
+        switch (value) {
+            case 1:
+                return "Jan";
+            case 2:
+                return "Feb";
+            case 3:
+                return "Mar";
+            case 4:
+                return "Apr";
+            case 5:
+                return "May";
+            case 6:
+                return "Jun";
+            case 7:
+                return "Jul";
+            case 8:
+                return "Aug";
+            case 9:
+                return "Sept";
+            case 10:
+                return "Oct";
+            case 11:
+                return "Nov";
+            case 12:
+                return "Dec";
+            default:
+                return "N/A";
+        }
+    }
+}
+
+const documentCreator = new DocumentCreator();
+
+const doc = documentCreator.create([experiences, education, skills, achievements]);
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/11-declaritive-styles-2.ts

@@ -0,0 +1,270 @@
+// Setting styles with JavaScript configuration
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    convertInchesToTwip,
+    Document,
+    Footer,
+    HeadingLevel,
+    ImageRun,
+    Packer,
+    Paragraph,
+    Table,
+    TableCell,
+    TableRow,
+    TabStopPosition,
+    UnderlineType,
+} from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 1.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 2.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 3.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 4.")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    styles: {
+        default: {
+            heading1: {
+                run: {
+                    font: "Calibri",
+                    size: 52,
+                    bold: true,
+                    color: "000000",
+                    underline: {
+                        type: UnderlineType.SINGLE,
+                        color: "000000",
+                    },
+                },
+                paragraph: {
+                    alignment: AlignmentType.CENTER,
+                    spacing: { line: 340 },
+                },
+            },
+            heading2: {
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 340 },
+                },
+            },
+            heading3: {
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 276 },
+                },
+            },
+            heading4: {
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    alignment: AlignmentType.JUSTIFIED,
+                },
+            },
+        },
+        paragraphStyles: [
+            {
+                id: "normalPara",
+                name: "Normal Para",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                    rightTabStop: TabStopPosition.MAX,
+                    leftTabStop: 453.543307087,
+                },
+            },
+            {
+                id: "normalPara2",
+                name: "Normal Para2",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                },
+                paragraph: {
+                    alignment: AlignmentType.JUSTIFIED,
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                },
+            },
+            {
+                id: "aside",
+                name: "Aside",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "999999",
+                    italics: true,
+                },
+                paragraph: {
+                    spacing: { line: 276 },
+                    indent: { left: convertInchesToTwip(0.5) },
+                },
+            },
+            {
+                id: "wellSpaced",
+                name: "Well Spaced",
+                basedOn: "Normal",
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
+                        top: 700,
+                        right: 700,
+                        bottom: 700,
+                        left: 700,
+                    },
+                },
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "1",
+                            style: "normalPara",
+                            alignment: AlignmentType.RIGHT,
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "HEADING",
+                    heading: HeadingLevel.HEADING_1,
+                    alignment: AlignmentType.CENTER,
+                }),
+                new Paragraph({
+                    text: "Ref. :",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Date :",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "To,",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "The Superindenting Engineer,(O &M)",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Sub : ",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Ref. : ",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Sir,",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "BRIEF DESCRIPTION",
+                    style: "normalPara",
+                }),
+                table,
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "Test",
+                    style: "normalPara2",
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "Test 2",
+                    style: "normalPara2",
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/12-scaling-images.ts

@@ -0,0 +1,62 @@
+// Scaling images
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ImageRun, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("Hello World"),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 50,
+                                height: 50,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 250,
+                                height: 250,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 400,
+                                height: 400,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/13-xml-styles.ts

@@ -0,0 +1,33 @@
+// This example shows 3 styles using XML styles
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph } from "../build";
+
+const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
+const doc = new Document({
+    title: "Title",
+    externalStyles: styles,
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "Cool Heading Text",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: 'This is a custom named style from the template "MyFancyStyle"',
+                    style: "MyFancyStyle",
+                }),
+                new Paragraph("Some normal text"),
+                new Paragraph({
+                    text: "MyFancyStyle again",
+                    style: "MyFancyStyle",
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/14-page-numbers.ts

@@ -0,0 +1,80 @@
+// Page numbers
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                titlePage: true,
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Header "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Footer - Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Footer "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("First Page"), new PageBreak()],
+                }),
+                new Paragraph("Second Page"),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/15-page-break-before.ts

@@ -0,0 +1,22 @@
+// Page break before example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("Hello World"),
+                new Paragraph({
+                    text: "Hello World on another page",
+                    pageBreakBefore: true,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/16-multiple-sections.ts

@@ -0,0 +1,147 @@
+// Multiple sections and headers
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, PageNumber, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [new Paragraph("Hello World")],
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [new Paragraph("First Default Header on another page")],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [new Paragraph("Footer on another page")],
+                }),
+            },
+
+            children: [new Paragraph("hello")],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.LANDSCAPE,
+                    },
+                    pageNumbers: {
+                        start: 1,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [new Paragraph("Second Default Header on another page")],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [new Paragraph("Footer on another page")],
+                }),
+            },
+            children: [new Paragraph("hello in landscape")],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+
+            children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                    pageNumbers: {
+                        formatType: PageNumberFormat.UPPER_ROMAN,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph(
+                    "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
+                ),
+            ],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                    pageNumbers: {
+                        start: 25,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph(
+                    "Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section.",
+                ),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/17-footnotes.ts

@@ -0,0 +1,55 @@
+// Footnotes
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, FootnoteReferenceRun, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    footnotes: {
+        1: { children: [new Paragraph("Foo"), new Paragraph("Bar")] },
+        2: { children: [new Paragraph("Test")] },
+        3: { children: [new Paragraph("My amazing reference")] },
+        4: { children: [new Paragraph("Foo1")] },
+        5: { children: [new Paragraph("Test1")] },
+        6: { children: [new Paragraph("My amazing reference1")] },
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            children: ["Hello", new FootnoteReferenceRun(1)],
+                        }),
+                        new TextRun({
+                            children: [" World!", new FootnoteReferenceRun(2)],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World"), new FootnoteReferenceRun(3)],
+                }),
+            ],
+        },
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            children: ["Hello", new FootnoteReferenceRun(4)],
+                        }),
+                        new TextRun({
+                            children: [" World!", new FootnoteReferenceRun(5)],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World"), new FootnoteReferenceRun(6)],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/18-image-from-buffer.ts

@@ -0,0 +1,30 @@
+// Insert image from a buffer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ImageRun, Packer, Paragraph } from "../build";
+
+const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: Buffer.from(imageBase64Data, "base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/19-export-to-base64.ts

@@ -0,0 +1,30 @@
+// Export to base64 string - Useful in a browser environment.
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tBar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBase64String(doc).then((str) => {
+    fs.writeFileSync("My Document.docx", str);
+});

demo/2-declaritive-styles.ts

@@ -0,0 +1,192 @@
+// Example on how to customise the look at feel using Styles
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    convertInchesToTwip,
+    Document,
+    HeadingLevel,
+    LevelFormat,
+    Packer,
+    Paragraph,
+    TextRun,
+    UnderlineType,
+} from "../build";
+
+const doc = new Document({
+    creator: "Clippy",
+    title: "Sample Document",
+    description: "A brief example of using docx",
+    styles: {
+        default: {
+            heading1: {
+                run: {
+                    size: 28,
+                    bold: true,
+                    italics: true,
+                    color: "red",
+                },
+                paragraph: {
+                    spacing: {
+                        after: 120,
+                    },
+                },
+            },
+            heading2: {
+                run: {
+                    size: 26,
+                    bold: true,
+                    underline: {
+                        type: UnderlineType.DOUBLE,
+                        color: "FF0000",
+                    },
+                },
+                paragraph: {
+                    spacing: {
+                        before: 240,
+                        after: 120,
+                    },
+                },
+            },
+            listParagraph: {
+                run: {
+                    color: "#FF0000",
+                },
+            },
+        },
+        paragraphStyles: [
+            {
+                id: "aside",
+                name: "Aside",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "999999",
+                    italics: true,
+                },
+                paragraph: {
+                    indent: {
+                        left: convertInchesToTwip(0.5),
+                    },
+                    spacing: {
+                        line: 276,
+                    },
+                },
+            },
+            {
+                id: "wellSpaced",
+                name: "Well Spaced",
+                basedOn: "Normal",
+                quickFormat: true,
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                },
+            },
+        ],
+    },
+    numbering: {
+        config: [
+            {
+                reference: "my-crazy-numbering",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.LOWER_LETTER,
+                        text: "%1)",
+                        alignment: AlignmentType.LEFT,
+                    },
+                ],
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "Test heading1, bold and italicized",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph("Some simple content"),
+                new Paragraph({
+                    text: "Test heading2 with double red underline",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "Option1",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                    style: "aside",
+                }),
+                new Paragraph({
+                    text: "Option5 -- override 2 to 5",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Option3",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Some monospaced content",
+                            font: {
+                                name: "Monospace",
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "An aside, in light gray italics and indented",
+                    style: "aside",
+                }),
+                new Paragraph({
+                    text: "This is normal, but well-spaced text",
+                    style: "wellSpaced",
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "This is a bold run,",
+                            bold: true,
+                        }),
+                        new TextRun(" switching to normal "),
+                        new TextRun({
+                            text: "and then underlined ",
+                            underline: {},
+                        }),
+                        new TextRun({
+                            text: "and then emphasis-mark ",
+                            emphasisMark: {},
+                        }),
+                        new TextRun({
+                            text: "and back to normal.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    style: "Strong",
+                    children: [
+                        new TextRun({
+                            text: "Strong Style",
+                        }),
+                        new TextRun({
+                            text: " - Very strong.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/20-table-cell-borders.ts

@@ -0,0 +1,107 @@
+// Add custom borders to table cell
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { BorderStyle, Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph("Hello")],
+                                    borders: {
+                                        top: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "red",
+                                        },
+                                        bottom: {
+                                            style: BorderStyle.DOUBLE,
+                                            size: 3,
+                                            color: "blue",
+                                        },
+                                        left: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "green",
+                                        },
+                                        right: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "#ff8000",
+                                        },
+                                    },
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/21-bookmarks.ts

@@ -0,0 +1,65 @@
+// This demo shows how to create bookmarks then link to them with internal hyperlinks
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun } from "../build";
+
+const LOREM_IPSUM =
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mi velit, convallis convallis scelerisque nec, faucibus nec leo. Phasellus at posuere mauris, tempus dignissim velit. Integer et tortor dolor. Duis auctor efficitur mattis. Vivamus ut metus accumsan tellus auctor sollicitudin venenatis et nibh. Cras quis massa ac metus fringilla venenatis. Proin rutrum mauris purus, ut suscipit magna consectetur id. Integer consectetur sollicitudin ante, vitae faucibus neque efficitur in. Praesent ultricies nibh lectus. Mauris pharetra id odio eget iaculis. Duis dictum, risus id pellentesque rutrum, lorem quam malesuada massa, quis ullamcorper turpis urna a diam. Cras vulputate metus vel massa porta ullamcorper. Etiam porta condimentum nulla nec tristique. Sed nulla urna, pharetra non tortor sed, sollicitudin molestie diam. Maecenas enim leo, feugiat eget vehicula id, sollicitudin vitae ante.";
+
+const doc = new Document({
+    creator: "Clippy",
+    title: "Sample Document",
+    description: "A brief example of using docx with bookmarks and internal hyperlinks",
+    sections: [
+        {
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new InternalHyperlink({
+                                    child: new TextRun({
+                                        text: "Click here!",
+                                        style: "Hyperlink",
+                                    }),
+                                    anchor: "myAnchorId",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    heading: HeadingLevel.HEADING_1,
+                    children: [
+                        new Bookmark({
+                            id: "myAnchorId",
+                            children: [new TextRun("Lorem Ipsum")],
+                        }),
+                    ],
+                }),
+                new Paragraph("\n"),
+                new Paragraph(LOREM_IPSUM),
+                new Paragraph({
+                    children: [new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [
+                        new InternalHyperlink({
+                            child: new TextRun({
+                                text: "Anchor Text",
+                                style: "Hyperlink",
+                            }),
+                            anchor: "myAnchorId",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/22-right-to-left-text.ts

@@ -0,0 +1,71 @@
+// This demo shows right to left for special languages
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    bidirectional: true,
+                    children: [
+                        new TextRun({
+                            text: "שלום עולם",
+                            rightToLeft: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    bidirectional: true,
+                    children: [
+                        new TextRun({
+                            text: "שלום עולם",
+                            bold: true,
+                            rightToLeft: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    bidirectional: true,
+                    children: [
+                        new TextRun({
+                            text: "שלום עולם",
+                            italics: true,
+                            rightToLeft: true,
+                        }),
+                    ],
+                }),
+                new Table({
+                    visuallyRightToLeft: true,
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [new Paragraph("שלום עולם")],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph("שלום עולם")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/23-base64-images.ts

@@ -0,0 +1,86 @@
+// This demo adds an image to the Media cache, and then insert to the document afterwards
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ImageRun, Packer, Paragraph, TextRun } from "../build";
+
+const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/image1.jpeg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/dog.png"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: Buffer.from(imageBase64Data, "base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/24-images-to-table-cell.ts

@@ -0,0 +1,97 @@
+// Add image to table cell
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            children: [
+                                                new ImageRun({
+                                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                                    transformation: {
+                                                        width: 100,
+                                                        height: 100,
+                                                    },
+                                                }),
+                                            ],
+                                        }),
+                                    ],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph("Hello")],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/25-table-xml-styles.ts

@@ -0,0 +1,51 @@
+// Example of how you would create a table and add data to it
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+
+const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
+
+// Create a table and pass the XML Style
+const table = new Table({
+    style: "MyCustomTableStyle",
+    width: {
+        size: 9070,
+        type: WidthType.DXA,
+    },
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Header Colum 1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("Header Colum 2")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Column Content 3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("Column Content 2")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    title: "Title",
+    externalStyles: styles,
+    sections: [
+        {
+            children: [table],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/26-paragraph-borders.ts

@@ -0,0 +1,35 @@
+// Creates two paragraphs, one with a border and one without
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("No border!"),
+                new Paragraph({
+                    text: "I have borders on my top and bottom sides!",
+                    border: {
+                        top: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                        bottom: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                    },
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/27-declaritive-styles-3.ts

@@ -0,0 +1,68 @@
+// Custom styles using JavaScript configuration
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
+
+const doc = new Document({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "myWonkyStyle",
+                name: "My Wonky Style",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "990000",
+                    italics: true,
+                },
+                paragraph: {
+                    indent: {
+                        left: convertInchesToTwip(0.5),
+                    },
+                    spacing: {
+                        line: 276,
+                    },
+                },
+            },
+            {
+                id: "Heading2",
+                name: "Heading 2",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    bold: true,
+                    size: 26,
+                    underline: {
+                        type: UnderlineType.DOUBLE,
+                        color: "FF0000",
+                    },
+                },
+                paragraph: {
+                    spacing: {
+                        before: 240,
+                        after: 120,
+                    },
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "Hello",
+                    style: "myWonkyStyle",
+                }),
+                new Paragraph({
+                    text: "World",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/28-table-of-contents.ts

@@ -0,0 +1,64 @@
+// Table of contents
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
+
+// WordprocessingML docs for TableOfContents can be found here:
+// http://officeopenxml.com/WPtableOfContents.php
+
+// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
+// making the entries be hyperlinks for the paragraph
+const doc = new File({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "MySpectacularStyle",
+                name: "My Spectacular Style",
+                basedOn: "Heading1",
+                next: "Heading1",
+                quickFormat: true,
+                run: {
+                    italics: true,
+                    color: "990000",
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new TableOfContents("Summary", {
+                    hyperlink: true,
+                    headingStyleRange: "1-5",
+                    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
+                }),
+                new Paragraph({
+                    text: "Header #1",
+                    heading: HeadingLevel.HEADING_1,
+                    pageBreakBefore: true,
+                }),
+                new Paragraph("I'm a little text very nicely written.'"),
+                new Paragraph({
+                    text: "Header #2",
+                    heading: HeadingLevel.HEADING_1,
+                    pageBreakBefore: true,
+                }),
+                new Paragraph("I'm a other text very nicely written.'"),
+                new Paragraph({
+                    text: "Header #2.1",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph("I'm a another text very nicely written.'"),
+                new Paragraph({
+                    text: "My Spectacular Style #1",
+                    style: "MySpectacularStyle",
+                    pageBreakBefore: true,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/29-numbered-lists.ts

@@ -0,0 +1,285 @@
+// Numbered lists
+// The lists can also be restarted by specifying the instance number
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.UPPER_ROMAN,
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
+                            },
+                        },
+                    },
+                ],
+                reference: "my-crazy-reference",
+            },
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
+                            },
+                        },
+                    },
+                ],
+                reference: "my-number-numbering-reference",
+            },
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL_ZERO,
+                        text: "[%1]",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
+                            },
+                        },
+                    },
+                ],
+                reference: "padded-numbering-reference",
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "line with contextual spacing",
+                    numbering: {
+                        reference: "my-crazy-reference",
+                        level: 0,
+                    },
+                    contextualSpacing: true,
+                    spacing: {
+                        before: 200,
+                    },
+                }),
+                new Paragraph({
+                    text: "line with contextual spacing",
+                    numbering: {
+                        reference: "my-crazy-reference",
+                        level: 0,
+                    },
+                    contextualSpacing: true,
+                    spacing: {
+                        before: 200,
+                    },
+                }),
+                new Paragraph({
+                    text: "line without contextual spacing",
+                    numbering: {
+                        reference: "my-crazy-reference",
+                        level: 0,
+                    },
+                    contextualSpacing: false,
+                    spacing: {
+                        before: 200,
+                    },
+                }),
+                new Paragraph({
+                    text: "line without contextual spacing",
+                    numbering: {
+                        reference: "my-crazy-reference",
+                        level: 0,
+                    },
+                    contextualSpacing: false,
+                    spacing: {
+                        before: 200,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 1 - Add sugar",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 2 - Add wheat",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 3 - Put in oven",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/3-numbering-and-bullet-points.ts

@@ -0,0 +1,256 @@
+// Numbering and bullet points example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                reference: "my-crazy-numbering",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.UPPER_ROMAN,
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.DECIMAL,
+                        text: "%2.",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(1), hanging: convertInchesToTwip(0.68) },
+                            },
+                        },
+                    },
+                    {
+                        level: 2,
+                        format: LevelFormat.LOWER_LETTER,
+                        text: "%3)",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(1.5), hanging: convertInchesToTwip(1.18) },
+                            },
+                        },
+                    },
+                    {
+                        level: 3,
+                        format: LevelFormat.UPPER_LETTER,
+                        text: "%4)",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2880, hanging: 2420 },
+                            },
+                        },
+                    },
+                ],
+            },
+            {
+                reference: "my-unique-bullet-points",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.BULLET,
+                        text: "\u1F60",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.BULLET,
+                        text: "\u00A5",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(1), hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 2,
+                        format: LevelFormat.BULLET,
+                        text: "\u273F",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2160, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 3,
+                        format: LevelFormat.BULLET,
+                        text: "\u267A",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2880, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 4,
+                        format: LevelFormat.BULLET,
+                        text: "\u2603",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 3600, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                ],
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "Hey you",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hello World 2",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Yeah boi",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hey you",
+                    bullet: {
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    bullet: {
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hello World 2",
+                    bullet: {
+                        level: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Yeah boi",
+                    bullet: {
+                        level: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "101 MSXFM",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "back to level 1",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "back to level 0",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Custom Bullet points",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hey you",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hello World 2",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Yeah boi",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "my Awesome numbering",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 4,
+                    },
+                }),
+                new Paragraph({
+                    text: "Back to level 1",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 1,
+                    },
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/30-template-document.ts

@@ -0,0 +1,35 @@
+// Example on how to use a template document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ImportDotx, Packer, Paragraph } from "../build";
+
+const importDotx = new ImportDotx();
+const filePath = "./demo/dotx/template.dotx";
+
+fs.readFile(filePath, (err, data) => {
+    if (err) {
+        throw new Error(`Failed to read file ${filePath}.`);
+    }
+
+    importDotx.extract(data).then((templateDocument) => {
+        const doc = new Document(
+            {
+                sections: [
+                    {
+                        properties: {
+                            titlePage: templateDocument.titlePageIsDefined,
+                        },
+                        children: [new Paragraph("Hello World")],
+                    },
+                ],
+            },
+            {
+                template: templateDocument,
+            },
+        );
+
+        Packer.toBuffer(doc).then((buffer) => {
+            fs.writeFileSync("My Document.docx", buffer);
+        });
+    });
+});

demo/31-tables.ts

@@ -0,0 +1,78 @@
+// Example of how you would create a table and add data to it
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [new Paragraph({}), new Paragraph({})],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph({}), new Paragraph({})],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
+                                    textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
+                                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text:
+                                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
+                                            heading: HeadingLevel.HEADING_1,
+                                        }),
+                                    ],
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "This text should be in the middle of the cell",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "Text above should be vertical from bottom to top",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "Text above should be vertical from top to bottom",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/32-merge-and-shade-table-cells.ts

@@ -0,0 +1,409 @@
+// Example of how you would merge cells together (Rows and Columns) and apply shading
+// Also includes an example on how to center tables
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    BorderStyle,
+    convertInchesToTwip,
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    ShadingType,
+    Table,
+    TableCell,
+    TableRow,
+    WidthType,
+} from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Hello")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table2 = new Table({
+    alignment: AlignmentType.CENTER,
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("World")],
+                    margins: {
+                        top: convertInchesToTwip(0.69),
+                        bottom: convertInchesToTwip(0.69),
+                        left: convertInchesToTwip(0.69),
+                        right: convertInchesToTwip(0.69),
+                    },
+                    columnSpan: 3,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.AUTO,
+    },
+    columnWidths: [convertInchesToTwip(0.69), convertInchesToTwip(0.69), convertInchesToTwip(0.69)],
+});
+
+const table3 = new Table({
+    alignment: AlignmentType.CENTER,
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Foo")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("v")],
+                    columnSpan: 3,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Bar1")],
+                    shading: {
+                        fill: "b79c2f",
+                        val: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                        color: "auto",
+                    },
+                }),
+                new TableCell({
+                    children: [new Paragraph("Bar2")],
+                    shading: {
+                        fill: "42c5f4",
+                        val: ShadingType.PERCENT_95,
+                        color: "auto",
+                    },
+                }),
+                new TableCell({
+                    children: [new Paragraph("Bar3")],
+                    shading: {
+                        fill: "880aa8",
+                        val: ShadingType.PERCENT_10,
+                        color: "e2df0b",
+                    },
+                }),
+                new TableCell({
+                    children: [new Paragraph("Bar4")],
+                    shading: {
+                        fill: "FF0000",
+                        val: ShadingType.CLEAR,
+                        color: "auto",
+                    },
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: convertInchesToTwip(4.86),
+        type: WidthType.DXA,
+    },
+    margins: {
+        top: convertInchesToTwip(0.27),
+        bottom: convertInchesToTwip(0.27),
+        right: convertInchesToTwip(0.27),
+        left: convertInchesToTwip(0.27),
+    },
+});
+
+const table4 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("0,0")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("1,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,1")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("2,0")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.PERCENTAGE,
+    },
+});
+
+const table5 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("0,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,1")],
+                    rowSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,2")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("1,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,2")],
+                    rowSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("2,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,1")],
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.PERCENTAGE,
+    },
+});
+
+const borders = {
+    top: {
+        style: BorderStyle.DASH_SMALL_GAP,
+        size: 1,
+        color: "red",
+    },
+    bottom: {
+        style: BorderStyle.DASH_SMALL_GAP,
+        size: 1,
+        color: "red",
+    },
+    left: {
+        style: BorderStyle.DASH_SMALL_GAP,
+        size: 1,
+        color: "red",
+    },
+    right: {
+        style: BorderStyle.DASH_SMALL_GAP,
+        size: 1,
+        color: "red",
+    },
+};
+
+const table6 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    borders,
+                    children: [new Paragraph("0,0")],
+                    rowSpan: 2,
+                }),
+                new TableCell({
+                    borders,
+                    children: [new Paragraph("0,1")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    borders,
+                    children: [new Paragraph("1,1")],
+                    rowSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    borders,
+                    children: [new Paragraph("2,0")],
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.PERCENTAGE,
+    },
+});
+
+const table7 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("0,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,2")],
+                    rowSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,3")],
+                    rowSpan: 3,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("1,0")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("2,0")],
+                    columnSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,2")],
+                    rowSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("3,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,3")],
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.PERCENTAGE,
+    },
+});
+
+const table8 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({ children: [new Paragraph("1,1")] }),
+                new TableCell({ children: [new Paragraph("1,2")] }),
+                new TableCell({ children: [new Paragraph("1,3")] }),
+                new TableCell({ children: [new Paragraph("1,4")], rowSpan: 4, borders }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({ children: [new Paragraph("2,1")] }),
+                new TableCell({ children: [new Paragraph("2,2")] }),
+                new TableCell({ children: [new Paragraph("2,3")], rowSpan: 3 }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({ children: [new Paragraph("3,1")] }),
+                new TableCell({ children: [new Paragraph("3,2")], rowSpan: 2 }),
+            ],
+        }),
+        new TableRow({
+            children: [new TableCell({ children: [new Paragraph("4,1")] })],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.PERCENTAGE,
+    },
+});
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                table,
+                new Paragraph({
+                    text: "Another table",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                table2,
+                new Paragraph({
+                    text: "Another table",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                table3,
+                new Paragraph("Merging columns 1"),
+                table4,
+                new Paragraph("Merging columns 2"),
+                table5,
+                new Paragraph("Merging columns 3"),
+                table6,
+                new Paragraph("Merging columns 4"),
+                table7,
+                new Paragraph("Merging columns 5"),
+                table8,
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/33-sequential-captions.ts

@@ -0,0 +1,49 @@
+// Sequential Captions
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, SequentialIdentifier, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 1->"),
+                        new SequentialIdentifier("Caption"),
+                        new TextRun(" text after sequencial caption 2->"),
+                        new SequentialIdentifier("Caption"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 1->"),
+                        new SequentialIdentifier("Label"),
+                        new TextRun(" text after sequencial caption 2->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 1->"),
+                        new SequentialIdentifier("Another"),
+                        new TextRun(" text after sequencial caption 3->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 2->"),
+                        new SequentialIdentifier("Another"),
+                        new TextRun(" text after sequencial caption 4->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/34-floating-tables.ts

@@ -0,0 +1,68 @@
+// Example of how you would create a table with float positions
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    Document,
+    OverlapType,
+    Packer,
+    Paragraph,
+    RelativeHorizontalPosition,
+    RelativeVerticalPosition,
+    Table,
+    TableAnchorType,
+    TableCell,
+    TableLayoutType,
+    TableRow,
+    WidthType,
+} from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Hello")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+    float: {
+        horizontalAnchor: TableAnchorType.MARGIN,
+        verticalAnchor: TableAnchorType.MARGIN,
+        relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
+        relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
+        overlap: OverlapType.NEVER,
+        leftFromText: 1000,
+        rightFromText: 2000,
+        topFromText: 1500,
+        bottomFromText: 30,
+    },
+    width: {
+        size: 4535,
+        type: WidthType.DXA,
+    },
+    layout: TableLayoutType.FIXED,
+});
+
+const doc = new Document({
+    sections: [
+        {
+            children: [table],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/35-hyperlinks.ts

@@ -0,0 +1,104 @@
+// Example on how to add hyperlinks to websites
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    footnotes: {
+        1: {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Click here for the "),
+                        new ExternalHyperlink({
+                            child: new TextRun({
+                                text: "Footnotes external hyperlink",
+                                style: "Hyperlink",
+                            }),
+                            link: "http://www.example.com",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    sections: [
+        {
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    child: new TextRun({
+                                        text: "Footer external hyperlink",
+                                        style: "Hyperlink",
+                                    }),
+                                    link: "http://www.example.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            headers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    child: new TextRun({
+                                        text: "Header external hyperlink",
+                                        style: "Hyperlink",
+                                    }),
+                                    link: "http://www.google.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new ExternalHyperlink({
+                            child: new TextRun({
+                                text: "Anchor Text",
+                                style: "Hyperlink",
+                            }),
+                            link: "http://www.example.com",
+                        }),
+                        new FootnoteReferenceRun(1),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ExternalHyperlink({
+                            child: new ImageRun({
+                                data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                transformation: {
+                                    width: 100,
+                                    height: 100,
+                                },
+                            }),
+                            link: "http://www.google.com",
+                        }),
+                        new ExternalHyperlink({
+                            child: new TextRun({
+                                text: "BBC News Link",
+                                style: "Hyperlink",
+                            }),
+                            link: "https://www.bbc.co.uk/news",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/36-image-to-table-cell.ts

@@ -0,0 +1,85 @@
+// Add image to table cell in a header and body
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Header, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+// Adding same table in the body and in the header
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [table],
+                }),
+            },
+            children: [table],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/37-images-to-header-and-footer.ts

@@ -0,0 +1,55 @@
+// Add images to header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Header, ImageRun, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/38-text-wrapping.ts

@@ -0,0 +1,54 @@
+// Example of how to "wrap" text around an image
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+// import { Document, Packer, Paragraph } from "../build";
+import { Document, ImageRun, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.",
+                ),
+                new Paragraph(
+                    "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.",
+                ),
+                new Paragraph(
+                    "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.",
+                ),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
+                            floating: {
+                                horizontalPosition: {
+                                    offset: 2014400,
+                                },
+                                verticalPosition: {
+                                    offset: 2014400,
+                                },
+                                wrap: {
+                                    type: TextWrappingType.SQUARE,
+                                    side: TextWrappingSide.BOTH_SIDES,
+                                },
+                                margins: {
+                                    top: 201440,
+                                    bottom: 201440,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/39-page-numbers.ts

@@ -0,0 +1,75 @@
+// Example how to display page numbers
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Foo Bar corp. "),
+                                new TextRun({
+                                    children: ["Page Number ", PageNumber.CURRENT],
+                                }),
+                                new TextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.CENTER,
+                            children: [
+                                new TextRun("Foo Bar corp. "),
+                                new TextRun({
+                                    children: ["Page Number: ", PageNumber.CURRENT],
+                                }),
+                                new TextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Hello World 1"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 2"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 3"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 4"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 5"), new PageBreak()],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/4-basic-table.ts

@@ -0,0 +1,132 @@
+// Example of how you would create a table and add data to it
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+
+const table = new Table({
+    columnWidths: [3505, 5505],
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 3505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    width: {
+                        size: 5505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 3505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+                new TableCell({
+                    width: {
+                        size: 5505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table2 = new Table({
+    columnWidths: [4505, 4505],
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table3 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({ text: "Table with skewed widths" }),
+                table,
+                new Paragraph({ text: "Table with equal widths" }),
+                table2,
+                new Paragraph({ text: "Table without setting widths" }),
+                table3,
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/40-line-numbers.ts

@@ -0,0 +1,33 @@
+// Example demonstrating line numbers.
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                lineNumbers: {
+                    countBy: 1,
+                    restart: LineNumberRestartFormat.CONTINUOUS,
+                },
+            },
+            children: [
+                new Paragraph({
+                    text: "Hello",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph(
+                    "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.",
+                ),
+                new Paragraph(
+                    "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.",
+                ),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/41-merge-table-cells-2.ts

@@ -0,0 +1,263 @@
+// Multiple cells merging in the same table - Rows and Columns
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("0,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,1")],
+                    columnSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,4")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("1,0")],
+                    columnSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,2")],
+                    columnSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,4")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("2,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,1")],
+                    columnSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,4")],
+                    columnSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("3,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("4,0")],
+                    columnSpan: 5,
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table2 = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("0,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,1")],
+                    rowSpan: 2,
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("0,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("1,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("1,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("2,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("2,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("3,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("3,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("4,0")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,2")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,4")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("4,5")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            children: [table, new Paragraph(""), table2],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/42-restart-page-numbers.ts

@@ -0,0 +1,93 @@
+// Page numbers - Start from 0 on a new section
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, PageNumberSeparator, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Header "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("First Page"), new PageBreak()],
+                }),
+                new Paragraph("Second Page"),
+            ],
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        separator: PageNumberSeparator.EM_DASH,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Header of Second section"),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Third Page"), new PageBreak()],
+                }),
+                new Paragraph("Fourth Page"),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/43-images-to-table-cell-2.ts

@@ -0,0 +1,86 @@
+// Add image to table cell
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                    rowSpan: 2,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            children: [table],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/44-multiple-columns.ts

@@ -0,0 +1,56 @@
+// Sections with multiple columns
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 2,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 2 columns on a page."),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
+        },
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 3,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 3 columns on a page."),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
+        },
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 2,
+                    separate: true,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 2 columns on a page."),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/45-highlighting-text.ts

@@ -0,0 +1,37 @@
+// Highlighting text
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun({
+                                    text: "Hello World",
+                                    color: "red",
+                                    bold: true,
+                                    size: 24,
+                                    font: {
+                                        name: "Garamond",
+                                    },
+                                    highlight: "yellow",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/46-shading-text.ts

@@ -0,0 +1,66 @@
+// Shading text
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Header, Packer, Paragraph, ShadingType, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun({
+                                    text: "Hello World",
+                                    color: "red",
+                                    bold: true,
+                                    size: 24,
+                                    font: {
+                                        name: "Garamond",
+                                    },
+                                    shading: {
+                                        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                        color: "00FFFF",
+                                        fill: "FF0000",
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
+                            shading: {
+                                type: ShadingType.DIAGONAL_CROSS,
+                                color: "00FFFF",
+                                fill: "FF0000",
+                            },
+                            children: [
+                                new TextRun({
+                                    text: "Hello World for entire paragraph",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            emboss: true,
+                            text: "Embossed text - hello world",
+                        }),
+                        new TextRun({
+                            imprint: true,
+                            text: "Imprinted text - hello world",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/47-number-of-total-pages-section.ts

@@ -0,0 +1,76 @@
+// Multiple sections with total number of pages in each section
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
+
+const header = new Header({
+    children: [
+        new Paragraph({
+            children: [
+                new TextRun("Header on another page"),
+                new TextRun({
+                    children: ["Page number: ", PageNumber.CURRENT],
+                }),
+                new TextRun({
+                    children: [" to ", PageNumber.TOTAL_PAGES_IN_SECTION],
+                }),
+            ],
+            alignment: AlignmentType.CENTER,
+        }),
+    ],
+});
+
+const footer = new Footer({
+    children: [new Paragraph("Foo Bar corp. ")],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: header,
+            },
+            footers: {
+                default: footer,
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
+                }),
+            ],
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: PageNumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: header,
+            },
+            footers: {
+                default: footer,
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Section 2"), new PageBreak(), new TextRun("Section 2"), new PageBreak()],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/48-vertical-align.ts

@@ -0,0 +1,33 @@
+// Example of making content of section vertically aligned
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, SectionVerticalAlignValue, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                verticalAlign: SectionVerticalAlignValue.CENTER,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/49-table-borders.ts

@@ -0,0 +1,167 @@
+// Add custom borders and no-borders to the table itself
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    BorderStyle,
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    Table,
+    TableBorders,
+    TableCell,
+    TableRow,
+    TextDirection,
+    VerticalAlign,
+} from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    borders: {
+                        top: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "red",
+                        },
+                        bottom: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "red",
+                        },
+                        left: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "red",
+                        },
+                        right: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "red",
+                        },
+                    },
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+// Using the no-border convenience object. It is the same as writing this manually:
+// const borders = {
+//     top: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     bottom: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     left: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     right: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     insideHorizontal: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     insideVertical: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+// };
+const noBorderTable = new Table({
+    borders: TableBorders.NONE,
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph({}), new Paragraph({})],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [new Paragraph({}), new Paragraph({})],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
+                    textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
+                }),
+                new TableCell({
+                    children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
+                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text:
+                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
+                            heading: HeadingLevel.HEADING_1,
+                        }),
+                    ],
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "This text should be in the middle of the cell",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "Text above should be vertical from bottom to top",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "Text above should be vertical from top to bottom",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [{ children: [table, new Paragraph("Hello"), noBorderTable] }],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/5-images.ts

@@ -0,0 +1,136 @@
+// Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    Document,
+    HorizontalPositionAlign,
+    HorizontalPositionRelativeFrom,
+    ImageRun,
+    Packer,
+    Paragraph,
+    VerticalPositionAlign,
+    VerticalPositionRelativeFrom,
+} from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("Hello World"),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/image1.jpeg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/dog.png").toString("base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                                flip: {
+                                    vertical: true,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 150,
+                                height: 150,
+                                flip: {
+                                    horizontal: true,
+                                },
+                                rotation: 225,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                flip: {
+                                    horizontal: true,
+                                    vertical: true,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                rotation: 45,
+                            },
+                            floating: {
+                                zIndex: 10,
+                                horizontalPosition: {
+                                    offset: 1014400,
+                                },
+                                verticalPosition: {
+                                    offset: 1014400,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
+                            floating: {
+                                zIndex: 5,
+                                horizontalPosition: {
+                                    relative: HorizontalPositionRelativeFrom.PAGE,
+                                    align: HorizontalPositionAlign.RIGHT,
+                                },
+                                verticalPosition: {
+                                    relative: VerticalPositionRelativeFrom.PAGE,
+                                    align: VerticalPositionAlign.BOTTOM,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/50-readme-demo.ts

@@ -0,0 +1,94 @@
+// The demo on the README.md
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "Hello",
+                            heading: HeadingLevel.HEADING_1,
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "World",
+                            heading: HeadingLevel.HEADING_1,
+                        }),
+                    ],
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "Hello World",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                table,
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/51-character-styles.ts

@@ -0,0 +1,58 @@
+// Custom character styles using JavaScript configuration
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    styles: {
+        characterStyles: [
+            {
+                id: "myRedStyle",
+                name: "My Wonky Style",
+                basedOn: "Normal",
+                run: {
+                    color: "990000",
+                    italics: true,
+                },
+            },
+            {
+                id: "strong",
+                name: "Strong",
+                basedOn: "Normal",
+                run: {
+                    bold: true,
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Foo bar",
+                            style: "myRedStyle",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "First Word",
+                            style: "strong",
+                        }),
+                        new TextRun({
+                            text:
+                                " - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/52-japanese.ts

@@ -0,0 +1,38 @@
+// Japanese text - Need to use a Japanese font
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "Normal",
+                name: "Normal",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "MS Gothic",
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "KFCを食べるのが好き",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "こんにちは",
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/53-chinese.ts

@@ -0,0 +1,91 @@
+// Chinese text - Chinese text need to use a Chinese font. And ascii text need to use a ascii font.
+// Different from the `52-japanese.ts`.
+//     `52-japanese.ts` will set all characters to use Japanese font.
+//     `53-chinese.ts` will set Chinese characters to use Chinese font, and set ascii characters to use ascii font.
+
+// Note that if the OS have not install `KaiTi` font, this demo doesn't work.
+
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    styles: {
+        default: {
+            document: {
+                run: {
+                    font: {
+                        ascii: "minorHAnsi",
+                        eastAsia: "minorEastAsia",
+                        cs: "minorBidi",
+                        hAnsi: "minorHAnsi",
+                    },
+                },
+            },
+        },
+        paragraphStyles: [
+            {
+                id: "Normal",
+                name: "Normal",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: {
+                        ascii: "minorHAnsi", // Can also use minorHAnsi
+                        eastAsia: "minorEastAsia", // Can also use minorEastAsia
+                        cs: "minorBidi",
+                        hAnsi: "minorHAnsi",
+                    },
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "中文和英文 Chinese and English",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "中文和英文 Chinese and English",
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "中文和英文 Chinese and English",
+                            font: { eastAsia: "SimSun" }, // set eastAsia to "SimSun".
+                            // The ascii characters will use the default font ("Times") specified in paragraphStyles
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: `店様付旅母正役基社発破班。発治治京岡局本因追意金紀統責郵滴尽。立功日庁重天富評界明済不着法返祉経正引行。載区列防新目治日群付無人道言越名。界安無死専体風木人教録覧訃。女問堂容県作先芸便効証帯債土全極的日。能山中岡仕関攻井季接店線幌温後率事阜止。成間路行究今式歌像祉帯式媛読徹。安行息古入出文侵監株登部席内文第珍鶴問用。
+    
+                編竹入俳多応日氏陸福芸北供動。情績拠僧肺軍油能認郷翌南対韓短東食束兵晶。政予任習口佐所当止市告号。悩申無式立医毎部観潟訴菱権。発臼背郎上予配光記芸注然出。梨場株以政囲下球品材県動政押婚面見。米共試使落帳遅毅間三子開。問与大八地芸第線体架辺今死。押構草齢戦重最変社豪記目盗連報準周込。系貸劇様重鷲始能質村異社学動導勤。
+                
+                残様的荻仲刺局標績供質球就雄。考和母問者役尊紙推新経革個事編安観。益学北日著楽車山勢流泉四犯投台戒設対臨百。危謄初治穴委済本索労刊回。月写政覧女事棋違年終索情響白子泉転企堀社。江遊著西高開面毎分芸責成創査全判調目止懇。原育会夏作売望人転乱融抜心。制川供健水示囲阜厚高右断季人役。持面必日暮気管像冬間影図健行格阪。
+                
+                来入工速会健評下町慮大貸社一見園外申憶。服豊舞入面沢交使奥見記写意岩。北観提女刊液城共五擦相売田合是由読。回歳売苦定記点郎意増賛治北渡本応。受送文携村陸情静了申注際。順負子研済老上変女産第内無費携投展達。東初乗回動合語学待聴暮沢流全場導敷記賞次。更物中備著後渡売第部時禁新田木下昨。備護起織服久権意全海馬適応。
+                
+                幸速団供地信討川安矛場消学年。去茂玉東今要出約元教負限載始今簡。編掲証的情仕渡室手映法部始。紙反語清阪曜税受知選謝個印観聞。教人超死準無者参生撤技真価椿景破市見国。左需臓道力趣暮際丁高会近部敗岡力当社。壊態毒期波超長写島断兆国世行共絞私報。反野番点図択女撃脱案情王援。減属考論月院催者門料約覧市戦。
+                
+                山部午金査投立集争教殺巣作世動北部応。通負考隙問粛中帯閉要程規化小。橋棋互界時引就現省竹去子無系容米。竹転起日本新田強済購書区庁集作容同会窓教。文公神転待究挙登投川選囲針能楽路断出歌。祥新現寄公史真玉属元始員金抜関前百衝能。国眺暮囲世嘘面外営国内報夜九掲事春葉。来月刊台先良理著自供法投。通渡請当月学安首一押実展介況。
+                
+                法優分独込右得里記域目順供進乗。憂婚転峰大写医投社曲題任能務熱県展覧港専。栄余歯真著改追事作果石芸。青感将南便再転領鈴投提鉄索競虎師体物想。牲打迎達携度開技書催掲安去変念座。革混疑生採就枢当住回県組北意寛。爆新和級掲交象温十賛展木開有結日。新海辺小除京物興量写界裁上。文師建関面取質也底沼画者図空医心無季。
+                
+                高館湯転名気業以際置講詰方活礎組調軽際。発変東作訪乃小化理利提目気。極季本問号面帯勤戦行新禁情堀郎携。座所転再祥業必変昌今歩佐王立抗後養崩。支物猪躍芸整縦焦供防続相護治時語朝分刊定。綿田幸崎責本欲間載神調崎答志政報与速美載。飯治止稿原先明画森群進見情幕。女民館終調質並伝車慌供科。支田国傷自動献疑討医足公成公主断的望。
+                
+                責開児食福実帰治師今策今。水重寺圧医観送連東者秒途。選央力律式開作掲写様階組戦写型紙。式国販時天遣国出難共前次領体康稲住転。査見保重議原速群者内月正連。爾天膨装芸別巨平運数準三浜念載創県奈飛提。素京発揮田談気党示見象定電類代級。善返跡国有話権入猛府週亡辞馬脳。関残主祐雪塚去集村完海関文受載表川護照立。
+                
+                発闘美慎健育旅布容広互無秋認天歌媛芸。転器合読県増認会賞倒点系。食気母服絵知去祝芸車報熱勝。能貿月更障文的欠賞現覇声敏施会。懲病写昼法族業律記聡生開緊楽暮護。東地二員者説盟治害討面提。第北乗査庭年近的禁疑報方店記必迷都流通。聞有力前愛院梨野関業前訳本清滋補。蒲読火死勝広保会婚際気二由保国。用君込村需起相点選紙拡氏訃不。`,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/54-custom-properties.ts

@@ -0,0 +1,27 @@
+// Custom Properties
+// Custom properties are incredibly useful if you want to be able to apply quick parts or custom cover pages
+// to the document in Word after the document has been generated. Standard properties (such as creator, title
+// and subject) cover typical use cases, but sometimes custom properties are required.
+
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer } from "../build";
+
+const doc = new Document(
+    // Standard properties
+    {
+        creator: "Creator",
+        title: "Title",
+        subject: "Subject",
+        description: "Description",
+        customProperties: [
+            { name: "Subtitle", value: "Subtitle" },
+            { name: "Address", value: "Address" },
+        ],
+        sections: [],
+    },
+);
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/55-math.ts

@@ -0,0 +1,296 @@
+// Simple example to add text to a document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    Document,
+    Math,
+    MathAngledBrackets,
+    MathCurlyBrackets,
+    MathFraction,
+    MathFunction,
+    MathPreSubSuperScript,
+    MathRadical,
+    MathRoundBrackets,
+    MathRun,
+    MathSquareBrackets,
+    MathSubScript,
+    MathSubSuperScript,
+    MathSum,
+    MathSuperScript,
+    Packer,
+    Paragraph,
+    TextRun,
+} from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRun("2+2"),
+                                new MathFraction({
+                                    numerator: [new MathRun("hi")],
+                                    denominator: [new MathRun("2")],
+                                }),
+                            ],
+                        }),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRun("1"),
+                                        new MathRadical({
+                                            children: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSum({
+                                    children: [new MathRun("test")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("e")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathRadical({
+                                            children: [new MathRun("i")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                    superScript: [new MathRun("10")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("test")],
+                                    subScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("x")],
+                                    subScript: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("y")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathPreSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("4")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [
+                                        new MathRadical({
+                                            children: [
+                                                new MathFraction({
+                                                    numerator: [new MathRun("1")],
+                                                    denominator: [new MathRun("2")],
+                                                }),
+                                            ],
+                                            degree: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("x")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRadical({
+                                    children: [new MathRun("4")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFunction({
+                                    name: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("cos")],
+                                            superScript: [new MathRun("-1")],
+                                        }),
+                                    ],
+                                    children: [new MathRun("100")],
+                                }),
+                                new MathRun("×"),
+                                new MathFunction({
+                                    name: [new MathRun("sin")],
+                                    children: [new MathRun("360")],
+                                }),
+                                new MathRun("= x"),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRoundBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathSquareBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathCurlyBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathAngledBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRadical({
+                                            children: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2a")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/56-background-color.ts

@@ -0,0 +1,34 @@
+// Change background colour of whole document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    background: {
+        color: "C45911",
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/57-add-parent-numbered-lists.ts

@@ -0,0 +1,89 @@
+// Numbered lists - Add parent number in sub number
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: 260 },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1.%2",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 1.25 * convertInchesToTwip(0.5), hanging: 1.25 * 260 },
+                            },
+                            run: {
+                                bold: true,
+                                size: 18,
+                                font: "Times New Roman",
+                            },
+                        },
+                    },
+                ],
+                reference: "my-number-numbering-reference",
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "How to make cake",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "Step 1 - Add sugar",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 2 - Add wheat",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 2a - Stir the wheat in a circle",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 3 - Put in oven",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "How to make cake",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/58-section-types.ts

@@ -0,0 +1,91 @@
+// Usage of different Section Types
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun, SectionType } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.CONTINUOUS,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.ODD_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.EVEN_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.NEXT_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/59-header-footer-margins.ts

@@ -0,0 +1,54 @@
+// Move + offset header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
+                        header: 100,
+                        footer: 50,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Header text",
+                            indent: {
+                                left: -400,
+                            },
+                        }),
+                        new Paragraph({
+                            text: "Some more header text",
+                            indent: {
+                                left: -600,
+                            },
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Footer text",
+                            indent: {
+                                left: -400,
+                            },
+                        }),
+                    ],
+                }),
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/6-page-borders.ts

@@ -0,0 +1,46 @@
+// Example of how to change page borders
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
+                        top: 0,
+                        right: 0,
+                        bottom: 0,
+                        left: 0,
+                    },
+                },
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "Hello World",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph("Foo bar"),
+                new Paragraph("Github is the best"),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/60-track-revisions.ts

@@ -0,0 +1,151 @@
+// Track Revisions aka. "Track Changes"
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    DeletedTextRun,
+    Document,
+    Footer,
+    FootnoteReferenceRun,
+    InsertedTextRun,
+    Packer,
+    PageNumber,
+    Paragraph,
+    ShadingType,
+    TextRun,
+} from "../build";
+
+/*
+    For reference, see
+    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
+    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
+
+    The method `addTrackRevisions()` adds an element `<w:trackRevisions />` to the `settings.xml` file. This specifies that the application shall track *new* revisions made to the existing document.
+    See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
+
+    Note that this setting enables to track *new changes* after teh file is generated, so this example will still show inserted and deleted text runs when you remove it.
+*/
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to ",
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+    ],
+});
+
+const doc = new Document({
+    footnotes: {
+        1: {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a footnote"),
+                        new DeletedTextRun({
+                            text: " with some extra text which was deleted",
+                            id: 0,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: " and new content",
+                            id: 1,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    features: {
+        trackRevisions: true,
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                paragraph,
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a demo "),
+                        new DeletedTextRun({
+                            break: 1,
+                            text: "in order",
+                            color: "red",
+                            bold: true,
+                            size: 24,
+                            font: {
+                                name: "Garamond",
+                            },
+                            shading: {
+                                type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                color: "00FFFF",
+                                fill: "FF0000",
+                            },
+                            id: 2,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:00:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: "to show how to ",
+                            bold: false,
+                            id: 3,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new TextRun({
+                            bold: true,
+                            children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
+                        }),
+                    ],
+                }),
+            ],
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.CENTER,
+                            children: [
+                                new TextRun("Awesome LLC"),
+                                new TextRun({
+                                    children: ["Page Number: ", PageNumber.CURRENT],
+                                }),
+                                new DeletedTextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                    id: 4,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                                new InsertedTextRun({
+                                    children: [" from ", PageNumber.TOTAL_PAGES],
+                                    bold: true,
+                                    id: 5,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/61-text-frame.ts

@@ -0,0 +1,73 @@
+// Text Frame (Text Box) example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, FrameAnchorType, HorizontalPositionAlign, Packer, Paragraph, TextRun, VerticalPositionAlign } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    frame: {
+                        position: {
+                            x: 1000,
+                            y: 3000,
+                        },
+                        width: 4000,
+                        height: 1000,
+                        anchor: {
+                            horizontal: FrameAnchorType.MARGIN,
+                            vertical: FrameAnchorType.MARGIN,
+                        },
+                        alignment: {
+                            x: HorizontalPositionAlign.CENTER,
+                            y: VerticalPositionAlign.TOP,
+                        },
+                    },
+                    border: {
+                        top: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                        bottom: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                        left: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                        right: {
+                            color: "auto",
+                            space: 1,
+                            value: "single",
+                            size: 6,
+                        },
+                    },
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/62-paragraph-spacing.ts

@@ -0,0 +1,36 @@
+// Simple example to add text to a document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, LineRuleType, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    spacing: {
+                        after: 5000,
+                        before: 5000,
+                    },
+                    children: [new TextRun("Hello World")],
+                }),
+                new Paragraph({
+                    spacing: {
+                        line: 2000,
+                        lineRule: LineRuleType.AUTO,
+                    },
+                    children: [
+                        new TextRun(
+                            "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed turpis ex, aliquet et faucibus quis, euismod in odio. Fusce gravida tempor nunc sed lacinia. Nulla sed dolor fringilla, fermentum libero ut, egestas ex. Donec pellentesque metus non orci lacinia bibendum. Cras porta ex et mollis hendrerit. Suspendisse id lectus suscipit, elementum lacus eu, convallis felis. Fusce sed bibendum dolor, id posuere ligula. Aliquam eu elit ut urna eleifend vestibulum. Praesent condimentum at turpis sed scelerisque. Suspendisse porttitor metus nec vestibulum egestas. Sed in eros sapien. Morbi efficitur placerat est a consequat. Nunc bibendum porttitor mi nec tempus. Morbi dictum augue porttitor nisi sodales sodales.",
+                        ),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/63-odd-even-header-footer.ts

@@ -0,0 +1,71 @@
+// Move + offset header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, PageBreak, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    evenAndOddHeaderAndFooters: true,
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Odd Header text",
+                        }),
+                        new Paragraph({
+                            text: "Odd - Some more header text",
+                        }),
+                    ],
+                }),
+                even: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Even header text",
+                        }),
+                        new Paragraph({
+                            text: "Even - Some more header text",
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Odd Footer text",
+                        }),
+                    ],
+                }),
+                even: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Even Cool Footer text",
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Hello World 1"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 2"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 3"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 4"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 5"), new PageBreak()],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/7-landscape.ts

@@ -0,0 +1,23 @@
+// Example of how to set the document to landscape
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, PageOrientation, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.LANDSCAPE,
+                    },
+                },
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/8-header-footer.ts

@@ -0,0 +1,26 @@
+// Add text to header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [new Paragraph("Header text")],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [new Paragraph("Footer text")],
+                }),
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/9-images-in-header-and-footer.ts

@@ -0,0 +1,50 @@
+// Add images to header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, ImageRun, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/browser-demo.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <script src="../build/index.js"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/1.3.8/FileSaver.js"></script>
+    </head>
+
+    <body>
+        <h1>DOCX browser Word document generation</h1>
+
+        <button type="button" onclick="generate()">Click to generate document</button>
+
+        <script>
+            function generate() {
+                const doc = new docx.Document();
+
+                const doc = new Document({
+                    sections: [
+                        {
+                            children: [
+                                new docx.Paragraph({
+                                    children: [
+                                        new docx.TextRun("Hello World"),
+                                        new docx.TextRun({
+                                            text: "Foo Bar",
+                                            bold: true,
+                                        }),
+                                        new docx.TextRun({
+                                            text: "\tGithub is the best",
+                                            bold: true,
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        },
+                    ],
+                });
+
+                docx.Packer.toBlob(doc).then((blob) => {
+                    console.log(blob);
+                    saveAs(blob, "example.docx");
+                    console.log("Document created successfully");
+                });
+            }
+        </script>
+    </body>
+</html>

demo/demo1.js

@@ -1,16 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-var paragraph = new docx.Paragraph("Hello World");
-var institutionText = new docx.TextRun("University College London").bold();
-var dateText = new docx.TextRun("5th Dec 2015").tab().bold();
-paragraph.addRun(institutionText);
-paragraph.addRun(dateText);
-
-doc.addParagraph(paragraph);
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo2.js

@@ -1,74 +0,0 @@
-const docx = require('../build');
-
-const doc = new docx.Document({
-    creator: 'Clippy',
-    title: 'Sample Document',
-    description: 'A brief example of using docx',
-});
-
-doc.Styles.createParagraphStyle('Heading1', 'Heading 1')
-    .basedOn("Normal")
-    .next("Normal")
-    .quickFormat()
-    .size(28)
-    .bold()
-    .italics()
-    .spacing({after: 120});
-
-doc.Styles.createParagraphStyle('Heading2', 'Heading 2')
-    .basedOn("Normal")
-    .next("Normal")
-    .quickFormat()
-    .size(26)
-    .bold()
-    .underline('double', 'FF0000')
-    .spacing({before: 240, after: 120});
-
-doc.Styles.createParagraphStyle('aside', 'Aside')
-    .basedOn('Normal')
-    .next('Normal')
-    .color('999999')
-    .italics()
-    .indent(720)
-    .spacing({line: 276});
-
-doc.Styles.createParagraphStyle('wellSpaced', 'Well Spaced')
-    .basedOn('Normal')
-    .spacing({line: 276, before: 20 * 72 * .1, after: 20 * 72 * .05});
-
-doc.Styles.createParagraphStyle('ListParagraph', 'List Paragraph')
-    .quickFormat()
-    .basedOn('Normal');
-
-
-const numberedAbstract = doc.Numbering.createAbstractNumbering();
-numberedAbstract.createLevel(0, "lowerLetter", "%1)", "left");
-
-doc.createParagraph('Test heading1, bold and italicized').heading1();
-doc.createParagraph('Some simple content');
-doc.createParagraph('Test heading2 with double red underline').heading2();
-
-const letterNumbering = doc.Numbering.createConcreteNumbering(numberedAbstract);
-const letterNumbering5 = doc.Numbering.createConcreteNumbering(numberedAbstract);
-letterNumbering5.overrideLevel(0, 5);
-
-doc.createParagraph('Option1').setNumbering(letterNumbering, 0);
-doc.createParagraph('Option5 -- override 2 to 5').setNumbering(letterNumbering5, 0);
-doc.createParagraph('Option3').setNumbering(letterNumbering, 0);
-
-doc.createParagraph()
-    .createTextRun('Some monospaced content')
-    .font('Monospace');
-
-doc.createParagraph('An aside, in light gray italics and indented').style('aside');
-doc.createParagraph('This is normal, but well-spaced text').style('wellSpaced');
-const para = doc.createParagraph();
-para.createTextRun('This is a bold run,').bold();
-para.createTextRun(' switching to normal ');
-para.createTextRun('and then underlined ').underline();
-para.createTextRun('and back to normal.');
-
-const exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo3.js

@@ -1,35 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-const numbering = new docx.Numbering();
-
-const abstractNum = numbering.createAbstractNumbering();
-abstractNum.createLevel(0, "upperRoman", "%1", "start")
-    .addParagraphProperty(new docx.Indent(720, 260));
-abstractNum.createLevel(1, "decimal", "%2.", "start")
-    .addParagraphProperty(new docx.Indent(1440, 980));
-abstractNum.createLevel(2, "lowerLetter", "%3)", "start")
-    .addParagraphProperty(new docx.Indent(2160, 1700));
-
-const concrete = numbering.createConcreteNumbering(abstractNum);
-
-var topLevelP = new docx.Paragraph("Hey you");
-var subP = new docx.Paragraph("What's up fam");
-var secondSubP = new docx.Paragraph("Hello World 2");
-var subSubP = new docx.Paragraph("Yeah boi");
-
-topLevelP.setNumbering(concrete, 0);
-subP.setNumbering(concrete, 1);
-secondSubP.setNumbering(concrete, 1);
-subSubP.setNumbering(concrete, 2);
-
-doc.addParagraph(topLevelP);
-doc.addParagraph(subP);
-doc.addParagraph(secondSubP);
-doc.addParagraph(subSubP);
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo4.js

@@ -1,12 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-const table = doc.createTable(4, 4);
-table.getCell(2, 2).addContent(new docx.Paragraph('Hello'));
-
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo5.js

@@ -1,17 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-var paragraph = new docx.Paragraph("Hello World");
-doc.addParagraph(paragraph);
-
-const image = doc.createImage("./demo/images/image1.jpeg");
-const image2 = doc.createImage("./demo/images/dog.png");
-const image3 = doc.createImage("./demo/images/cat.jpg");
-const image4 = doc.createImage("./demo/images/parrots.bmp");
-const image5 = doc.createImage("./demo/images/pizza.gif");
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo6.js

@@ -1,25 +0,0 @@
-const docx = require("../build");
-
-var doc = new docx.Document(undefined, {
-    top: 0,
-    right: 0,
-    bottom: 0,
-    left: 0,
-});
-
-var paragraph = new docx.Paragraph("Hello World");
-var institutionText = new docx.TextRun("University College London").bold();
-var dateText = new docx.TextRun("5th Dec 2015").tab().bold();
-paragraph.addRun(institutionText);
-paragraph.addRun(dateText);
-
-doc.addParagraph(paragraph);
-
-doc.createParagraph("Hello World").heading1();
-doc.createParagraph("University College London");
-doc.createParagraph("5th Dec 2015");
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack("My Document");
-
-console.log("Document created successfully at project root!");

demo/demo7.js

@@ -1,14 +0,0 @@
-const docx = require("../build");
-
-var doc = new docx.Document(undefined, {
-    orientation: "landscape",
-});
-
-var paragraph = new docx.Paragraph("Hello World");
-
-doc.addParagraph(paragraph);
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack("My Document");
-
-console.log("Document created successfully at project root!");

demo/demo8.js

@@ -1,13 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-doc.createParagraph("Hello World");
-
-doc.Header.createParagraph("Header text");
-doc.Footer.createParagraph("Footer text");
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/demo9.js

@@ -1,13 +0,0 @@
-const docx = require('../build');
-
-var doc = new docx.Document();
-
-doc.createParagraph("Hello World");
-
-doc.Header.createImage("./demo/images/pizza.gif");
-doc.Footer.createImage("./demo/images/pizza.gif");
-
-var exporter = new docx.LocalPacker(doc);
-exporter.pack('My Document');
-
-console.log('Document created successfully at project root!');

demo/index.js

@@ -1,29 +0,0 @@
-var prompt = require('prompt');
-var shelljs = require('shelljs');
-var fs = require('fs');
-
-console.log('What demo do you wish to run? (Enter a number)');
-
-var schema = {
-    properties: {
-        number: {
-            pattern: /^[0-9]+$/,
-            message: 'Please enter a number.',
-            required: true
-        }
-    }
-};
-
-prompt.start();
-
-prompt.get(schema, function (err, result) {
-    var demoNumber = result.number;
-    var filePath = `./demo/demo${demoNumber}.js`;
-
-    if (!fs.existsSync(filePath)) {
-        console.error(`demo${demoNumber} does not exist: ${filePath}`);
-        return;
-    }
-    console.log(`Running demo ${demoNumber}`);
-    shelljs.exec(`node ${filePath}`);
-});

demo/index.ts

@@ -0,0 +1,37 @@
+// tslint:disable:no-console
+import * as fs from "fs";
+import * as prompt from "prompt";
+import * as shelljs from "shelljs";
+
+console.log("What demo do you wish to run? (Enter a number)");
+
+const schema = {
+    properties: {
+        number: {
+            pattern: /^[0-9]+$/,
+            message: "Please enter a number.",
+            required: true,
+        },
+    },
+};
+
+prompt.start();
+
+prompt.get(schema, (_, result) => {
+    const demoNumber = result.number;
+    const files = fs.readdirSync("./demo").filter((fn) => fn.startsWith(demoNumber));
+
+    if (files.length === 0) {
+        console.error(`demo number ${demoNumber} does not exist`);
+        return;
+    }
+
+    const filePath = `./demo/${files[0]}`;
+
+    console.log(`Running demo ${demoNumber}: ${files[0]}`);
+    if (shelljs.exec(`npm run ts-node -- ${filePath}`).code === 0) {
+        console.log("Document created successfully");
+    } else {
+        console.error("Something went wrong with the demo");
+    }
+});

deploy-docs.sh

@@ -1,68 +0,0 @@
-#!/bin/bash
-set -e # Exit with nonzero exit code if anything fails
-
-SOURCE_BRANCH="master"
-TARGET_BRANCH="gh-pages"
-
-function doCompile {
-  npm run typedoc
-}
-
-# Pull requests and commits to other branches shouldn't try to deploy, just build to verify
-if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "$SOURCE_BRANCH" ]; then
-    echo "Skipping deploy; just doing a build."
-    doCompile
-    exit 0
-fi
-
-# Save some useful information
-REPO=`git config remote.origin.url`
-SSH_REPO=${REPO/https:\/\/github.com\//git@github.com:}
-SHA=`git rev-parse --verify HEAD`
-
-# Clone the existing gh-pages for this repo into docs/
-# Create a new empty branch if gh-pages doesn't exist yet (should only happen on first deply)
-git clone $REPO docs
-cd docs
-git checkout $TARGET_BRANCH || git checkout --orphan $TARGET_BRANCH
-cd ..
-
-# Clean out existing contents
-# echo "Cleaning out existing contents."
-# rm -rf docs/*
-
-# Run our compile script
-doCompile
-
-# Now let's go have some fun with the cloned repo
-cd docs
-git config user.name "Travis CI"
-git config user.email "dolan_miu@hotmail.com"
-ls
-
-# add .nojekyll file
-touch .nojekyll
-
-# If there are no changes to the compiled out (e.g. this is a README update) then just bail.
-if [ -z `git diff --exit-code` ]; then
-    echo "No changes to the output on this push; exiting."
-    exit 0
-fi
-
-# Commit the "changes", i.e. the new version.
-# The delta will show diffs between new and old versions.
-git add .
-git commit -m "Deploy to GitHub Pages: ${SHA}"
-
-# Get the deploy key by using Travis's stored variables to decrypt deploy-key.enc
-ENCRYPTED_KEY_VAR="encrypted_${ENCRYPTION_LABEL}_key"
-ENCRYPTED_IV_VAR="encrypted_${ENCRYPTION_LABEL}_iv"
-ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR}
-ENCRYPTED_IV=${!ENCRYPTED_IV_VAR}
-openssl aes-256-cbc -K $ENCRYPTED_KEY -iv $ENCRYPTED_IV -in deploy-key.enc -out deploy-key -d
-chmod 600 deploy-key
-eval `ssh-agent -s`
-ssh-add deploy-key
-
-# Now that we're all set up, we can push.
-git push $SSH_REPO $TARGET_BRANCH

docs/README.md

@@ -0,0 +1,64 @@
+# Welcome
+
+## Installation
+
+```sh
+npm install --save docx
+```
+
+Then you can `require` or `import` as usual:
+
+```ts
+const docx = require("docx");
+```
+
+```ts
+import * as docx from "docx";
+// or
+import { ... } from "docx";
+```
+
+## Basic Usage
+
+```ts
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "docx";
+
+// Documents contain sections, you can have multiple sections per document, go here to learn more about sections
+// This simple example will only contain one section
+const doc = new Document({
+    sections: [{
+        properties: {},
+        children: [
+            new Paragraph({
+                children: [
+                    new TextRun("Hello World"),
+                    new TextRun({
+                        text: "Foo Bar",
+                        bold: true,
+                    }),
+                    new TextRun({
+                        text: "\tGithub is the best",
+                        bold: true,
+                    }),
+                ],
+            }),
+        ],
+    }];
+});
+
+// Used to export the file into a .docx file
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});
+
+// Done! A file called 'My Document.docx' will be in your file system.
+```
+
+<p align="center">
+    <img alt="clippy the assistant" src="./clippy.png">
+</p>
+
+---
+
+Made with 💖

docs/_coverpage.md

@@ -0,0 +1,10 @@
+<img src="https://i.imgur.com/37uBGhO.gif" alt="drawing" style="width:200px;"/>
+
+> Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
+
+-   Simple, declarative API
+-   60+ usage examples
+-   Battle tested, mature, 98%+ coverage
+
+[GitHub](https://github.com/dolanmiu/docx)
+[Get Started](#Welcome)

docs/_sidebar.md

@@ -0,0 +1,36 @@
+* [Getting Started](/)
+
+* [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
+
+* API
+
+    * [Documentation](https://docx.js.org/api/)
+
+* Usage
+
+	* [Document](usage/document.md)
+    * [Sections](usage/sections.md)
+	* [Paragraph](usage/paragraph.md)
+	* [Text](usage/text.md)
+	* [Image](usage/images.md)
+	* [Headers & Footers](usage/headers-and-footers.md)
+	* [Bullet Points](usage/bullet-points.md)
+    * [Numbering](usage/numbering.md)
+    * [Tables](usage/tables.md)
+	* [Tab Stops](usage/tab-stops.md)
+    * [Table of Contents](usage/table-of-contents.md)
+    * [Page Numbers](usage/page-numbers.md)
+    * [Change Tracking](usage/change-tracking.md)
+    * [Math](usage/math.md)
+    * [Text Frames](usage/text-frames.md)
+	* Styling
+        * [Styling with JS](usage/styling-with-js.md)
+        * [Styling with XML](usage/styling-with-xml.md)
+* Exporting
+
+    * [Packers](usage/packers.md)
+* Utility
+
+    * [Convenience functions](usage/convenience-functions.md)
+
+* [Contribution Guidelines](contribution-guidelines.md)

docs/contribution-guidelines.md

@@ -0,0 +1,197 @@
+# Contribution Guidelines
+
+-   Include documentation reference(s) at the top of each file:
+
+    ```ts
+    // http://officeopenxml.com/WPdocument.php
+    ```
+
+-   Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
+
+-   Follow the `TSLint` rules
+
+## Always think about the user
+
+Put yourself in their position, and imagine how they would feel about your feature you wrote.
+
+1. Is it easy to use?
+2. Has it been documented well?
+3. Is it intuitive?
+4. Is it declarative?
+5. Is it fun to use?
+
+## Good Commit Names
+
+Please write good commit messages when making a commit: https://chris.beams.io/posts/git-commit/
+
+**Do not:**
+
+```
+c // What?
+rtl // Adding acryonyms without explaining anything else is not helpful
+works! // Glad its working, but the message is not helpful
+demo updated // Getting better, but capitalize the first letter
+Unesesary coment removed // Make sure to use correct spelling
+```
+
+**Do**
+
+`ITableFloatOptions` is an interface for a JSON of primitives. The end user would need to pass in a json object and not need to worry about the internals:
+
+```ts
+    public float(tableFloatOptions: ITableFloatOptions): Table
+```
+
+## Delcariative API
+
+Make sure the API is declarative, so no _method calling_ or _mutation_. This is a design decision, consistent with the rest of the project. There are benefits to delcariative code over other styles of code, explained here: https://dzone.com/articles/why-declarative-coding-makes-you-a-better-programm
+
+**Do not:**
+
+```ts
+const paragraph = doc.createParagraph();
+const text = paragraph.createText();
+text.contents = "Hello World";
+```
+
+**Do**
+
+```ts
+const doc = new Document({
+    sections: [{
+        children: [
+            new Paragraph({
+                children: [new TextRun("Hello World")],
+            }),
+        ],
+    }];
+});
+```
+
+## Getters and Setters
+
+Getters and Setters are done with a capital letter like so:
+
+```ts
+public get Level() {
+   ...
+}
+```
+
+This is the convention of this project. There is no performance advantage by doing this. It means we don't need to prefix all private variables with `_`:
+
+**Do not:**
+
+```ts
+private get _level: string;
+```
+
+**Do**
+
+```ts
+private get level: string;
+```
+
+## Interfaces over type alias
+
+Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
+
+> "In general, use what you want ( type alias / interface ) just be consistent"
+> "always use interface for public API's definition when authoring a library or 3rd party ambient type definitions"
+>
+> -   https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
+
+`Interface` is generally preferred over `type`: https://stackoverflow.com/questions/37233735/typescript-interfaces-vs-types
+
+**Do not:**
+
+```ts
+type RelationshipFileInfo = { id: number; target: string };
+```
+
+**Do:**
+
+```ts
+interface IRelationshipFileInfo {
+    id: number;
+    target: string;
+}
+```
+
+## String enums vs type
+
+To take full advantage of TypeScript's typing system, its best to use `string enums`:
+
+**Do not:**
+
+```ts
+type WeaponType = "bow" | "sword" | "wand";
+```
+
+**Do:**
+
+```ts
+enum WeaponType = {
+    BOW = "bow",
+    SWORD = "sword",
+    WAND = "wand",
+}
+```
+
+## Spell correctly, in full and in American English
+
+**Do not:**
+
+```ts
+readdy; // misspelling
+perm; // abbreviation
+conf; // abbreviation
+cnty; // abbreviation
+relationFile; // abbreviation
+colour; // U.K. English
+```
+
+**Do:**
+
+```ts
+ready;
+permission;
+config;
+country;
+relationshipFile;
+color;
+```
+
+## Keep files small (within reason)
+
+To minimize merge conflicts, reduce complexity, and improve readability, keep the files small.
+
+## Name files and folders with `/foo-bar/kebab-case.ts`
+
+To be consistent and in-line with the project, name files `like-this.ts`.
+
+https://stackoverflow.com/questions/7273316/what-is-the-javascript-filename-naming-convention
+
+## Testing
+
+Please write a test of every file you make and suffix it with `.spec.ts`.
+
+Here is a template of a test:
+
+```ts
+import { assert } from "chai";
+
+describe("ClassName", () => {
+    beforeEach(() => {
+        // TODO
+    });
+
+    describe("#methodName()", () => {
+        it("should ", () => {
+            // TODO
+        });
+    });
+});
+```
+
+Try not to use the `tests/utility.ts` file as this is being deprecated.

docs/index.html

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <title>docx - Generate .docx documents with JavaScript</title>
+        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+        <meta name="description" content="Generate .docx documents with JavaScript" />
+        <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
+        <link
+            rel="stylesheet"
+            href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
+            title="docsify-darklight-theme"
+            type="text/css"
+        />
+    </head>
+
+    <body>
+        <div id="app"></div>
+        <script>
+            window.$docsify = {
+                name: "docx",
+                repo: "https://github.com/dolanmiu/docx",
+                loadSidebar: true,
+                subMaxLevel: 2,
+                search: "auto",
+                coverpage: true,
+            };
+        </script>
+        <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+        <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+        <script src="https://unpkg.com/docsify-copy-code@2"></script>
+        <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+        <script src="//unpkg.com/prismjs/components/prism-typescript.min.js"></script>
+        <script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js" type="text/javascript"></script>
+    </body>
+</html>

docs/usage/bullet-points.md

@@ -0,0 +1,32 @@
+# Bullet Points
+
+!> Bullet Points requires an understanding of [Paragraphs](usage/paragraph.md).
+## Example
+
+To make a bullet point, simply make a paragraph into a bullet point:
+
+```ts
+const doc = new Document({
+    sections: [{
+        children: [
+            new Paragraph({
+                text: "Bullet points",
+                bullet: {
+                level: 0 //How deep you want the bullet to be
+            }
+            }),
+            new Paragraph({
+                text: "Are awesome",
+                bullet: {
+                level: 0
+            }
+            })
+        ],
+    }];
+});
+```
+
+### This will produce:
+
+-   Bullet points
+-   Are awesome

docs/usage/change-tracking.md

@@ -0,0 +1,61 @@
+# Change Tracking
+
+> Instead of adding a `TextRun` into a `Paragraph`, you can also add an `InsertedTextRun` or `DeletedTextRun` where you need to supply an `id`, `author` and `date` for the change.
+
+```ts
+import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to "
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+Note that for a `InsertedTextRun` and `DeletedTextRun`, it is not possible to simply call it with only a text as in `new TextRun("some text")`, since the additonal fields for change tracking need to be provided. Similar to a normal `TextRun` you can add additional text properties.
+
+```ts
+import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo"),
+        new DeletedTextRun({
+            text: "with a deletion.",
+            color: "red",
+            bold: true,
+            size: 24,
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+In addtion to marking text as inserted or deleted, change tracking can also be added via the document settings. This will enable new changes to be tracked as well.
+
+```ts
+import { Document } from "docx";
+
+const doc = new Document({
+    features: {
+        trackRevisions: true,
+    },
+});
+```