Merge pull request #596 from SpringMT/master

feat: Add decimalFullWidth numbering type

.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']

.gitignore

@@ -52,7 +52,6 @@ docs/.nojekyll
 .idea
 
 # Lock files
-package-lock.json
 yarn.lock
 
 # Documents

.nycrc

@@ -1,14 +1,15 @@
 {
   "check-coverage": true,
-  "lines": 87.54,
-  "functions": 83.61,
-  "branches": 72.57,
-  "statements": 87.32,
+  "lines": 96.81,
+  "functions": 93.80,
+  "branches": 92.63,
+  "statements": 96.80,
   "include": [
     "src/**/*.ts"
   ],
   "exclude": [
-    "src/**/*.spec.ts"
+    "src/**/*.spec.ts",
+    "src/import-dotx/import-dotx.ts"
   ],
   "reporter": [
     "lcov",

.travis.yml

@@ -9,43 +9,43 @@ script:
   - npm run test.coverage
   - npm run style
   - npm run build
-  - npm run ts-node -- ./demo/demo1.ts
-  - npm run e2e "My Document.docx"
-  - npm run ts-node -- ./demo/demo2.ts
-  - npm run ts-node -- ./demo/demo3.ts
-  - npm run ts-node -- ./demo/demo4.ts
-  - npm run ts-node -- ./demo/demo5.ts
-  - npm run ts-node -- ./demo/demo6.ts
-  - npm run ts-node -- ./demo/demo7.ts
-  - npm run ts-node -- ./demo/demo8.ts
-  - npm run ts-node -- ./demo/demo9.ts
-  - npm run ts-node -- ./demo/demo10.ts
-  - npm run e2e "My Document.docx"
-  - npm run ts-node -- ./demo/demo11.ts
-  - npm run ts-node -- ./demo/demo12.ts
-  - npm run ts-node -- ./demo/demo13.ts
-  - npm run ts-node -- ./demo/demo14.ts
-  - npm run ts-node -- ./demo/demo15.ts
-  - npm run ts-node -- ./demo/demo16.ts
-  - npm run ts-node -- ./demo/demo17.ts
-  - npm run ts-node -- ./demo/demo18.ts
-  - npm run ts-node -- ./demo/demo19.ts
-  - npm run ts-node -- ./demo/demo20.ts
-  - npm run ts-node -- ./demo/demo21.ts
-  - npm run ts-node -- ./demo/demo22.ts
-  - npm run ts-node -- ./demo/demo23.ts
-  - npm run ts-node -- ./demo/demo24.ts
+  - 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/demo26.ts
-  - npm run ts-node -- ./demo/demo27.ts
-  - npm run ts-node -- ./demo/demo28.ts
-  - npm run ts-node -- ./demo/demo29.ts
-  - npm run ts-node -- ./demo/demo30.ts
-  - npm run ts-node -- ./demo/demo31.ts
-  - npm run ts-node -- ./demo/demo32.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/demo33.ts
-  - npm run ts-node -- ./demo/demo34.ts
+  - 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:

README.md

@@ -18,7 +18,7 @@
 [![codecov][codecov-image]][codecov-url]
 
 <p align="center">
-    <img src="https://i.imgur.com/H5FA1Qy.gif" alt="drawing" width="800"/>
+    <img src="https://i.imgur.com/TCH0YzD.png" alt="drawing" width="800"/>
 </p>
 
 # Demo
@@ -27,13 +27,22 @@
 
 Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
 
-*   https://codepen.io/anon/pen/dqoVgQ
-*   https://jsfiddle.net/3xhezb5w/2
+*   https://codepen.io/dolanmiu/pen/RwNeObg
+*   https://jsfiddle.net/dolanmiu/kqxrj35u/1/
 
 Here is an example of `docx` working in `Angular`:
 
 *   https://stackblitz.com/edit/angular-afvxtz
 
+Here is an example of `docx` working in `React`:
+
+*   https://stackblitz.com/edit/react-ts-qq25sp
+*   https://stackblitz.com/edit/react-ts-qdqu7z (adding images to Word Document)
+
+Here is an example of `docx` working in `Vue.js`:
+
+*   https://stackblitz.com/edit/vuejs-docx
+
 ## Node
 
 Press `endpoint` on the `RunKit` website:
@@ -50,7 +59,7 @@ Press `endpoint` on the `RunKit` website:
 *   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
 *   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
 
-More [here](https://docx.js.org/#/examples) and [here](https://github.com/dolanmiu/docx/tree/master/demo)
+More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
 # How to use & Documentation
 
@@ -66,9 +75,19 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 
 # Used by
 
-[<img src="https://i.imgur.com/zy5qWmI.png" alt="drawing" height="200"/>](https://hfour.com/)
-[<img src="https://i.imgur.com/OYP5tgS.png" alt="drawing" height="200"/>](https://fuzzproductions.com/)
-[<img src="https://i.imgur.com/zUDMfZ3.png" alt="drawing" height="200"/>](https://www.mettzer.com/)
+[<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://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/)
+
+
+...and many more!
 
 ---
 

demo/1-basic.ts

@@ -0,0 +1,29 @@
+// 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();
+
+doc.addSection({
+    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

@@ -1,7 +1,7 @@
 // Generate a CV
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
 
 // tslint:disable:no-shadowed-variable
 
@@ -127,150 +127,168 @@ const achievements = [
 ];
 
 class DocumentCreator {
-    public create(data: object[]): Document {
-        // tslint:disable-next-line:no-any
-        const experiences = data[0] as any[];
-        // tslint:disable-next-line:no-any
-        const educations = data[1] as any[];
-        const skills = data[2] as object[];
-        const achivements = data[3] as object[];
+    // tslint:disable-next-line: typedef
+    public create([experiences, educations, skills, achivements]): Document {
         const document = new Document();
-        document.addParagraph(new Paragraph("Dolan Miu").title());
 
-        document.addParagraph(this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL));
-        document.addParagraph(this.createHeading("Education"));
+        document.addSection({
+            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}`));
 
-        for (const education of educations) {
-            document.addParagraph(
-                this.createInstitutionHeader(education.schoolName, `${education.startDate.year} - ${education.endDate.year}`),
-            );
-            document.addParagraph(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`));
+                        const bulletPoints = this.splitParagraphIntoBullets(education.notes);
+                        bulletPoints.forEach((bulletPoint) => {
+                            arr.push(this.createBullet(bulletPoint));
+                        });
 
-            const bulletPoints = this.splitParagraphIntoBullets(education.notes);
-            bulletPoints.forEach((bulletPoint) => {
-                document.addParagraph(this.createBullet(bulletPoint));
-            });
-        }
+                        return arr;
+                    })
+                    .reduce((prev, curr) => prev.concat(curr), []),
+                this.createHeading("Experience"),
+                ...experiences
+                    .map((position) => {
+                        const arr: Paragraph[] = [];
 
-        document.addParagraph(this.createHeading("Experience"));
+                        arr.push(
+                            this.createInstitutionHeader(
+                                position.company.name,
+                                this.createPositionDateText(position.startDate, position.endDate, position.isCurrent),
+                            ),
+                        );
+                        arr.push(this.createRoleText(position.title));
 
-        for (const position of experiences) {
-            document.addParagraph(
-                this.createInstitutionHeader(
-                    position.company.name,
-                    this.createPositionDateText(position.startDate, position.endDate, position.isCurrent),
+                        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",
                 ),
-            );
-            document.addParagraph(this.createRoleText(position.title));
+                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,
+                }),
+            ],
+        });
 
-            const bulletPoints = this.splitParagraphIntoBullets(position.summary);
-
-            bulletPoints.forEach((bulletPoint) => {
-                document.addParagraph(this.createBullet(bulletPoint));
-            });
-        }
-
-        document.addParagraph(this.createHeading("Skills, Achievements and Interests"));
-
-        document.addParagraph(this.createSubHeading("Skills"));
-        document.addParagraph(this.createSkillList(skills));
-
-        document.addParagraph(this.createSubHeading("Achievements"));
-
-        for (const achievementParagraph of this.createAchivementsList(achivements)) {
-            document.addParagraph(achievementParagraph);
-        }
-
-        document.addParagraph(this.createSubHeading("Interests"));
-
-        document.addParagraph(this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."));
-
-        document.addParagraph(this.createHeading("References"));
-
-        document.addParagraph(
-            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",
-            ),
-        );
-        document.addParagraph(new Paragraph("More references upon request"));
-        document.addParagraph(
-            new Paragraph(
-                "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.",
-            ).center(),
-        );
         return document;
     }
 
     public createContactInfo(phoneNumber: string, profileUrl: string, email: string): Paragraph {
-        const paragraph = new Paragraph().center();
-        const contactInfo = new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`);
-        const address = new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break();
-
-        paragraph.addRun(contactInfo);
-        paragraph.addRun(address);
-
-        return paragraph;
+        return new Paragraph({
+            alignment: AlignmentType.CENTER,
+            children: [
+                new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`),
+                new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break(),
+            ],
+        });
     }
 
     public createHeading(text: string): Paragraph {
-        return new Paragraph(text).heading1().thematicBreak();
+        return new Paragraph({
+            text: text,
+            heading: HeadingLevel.HEADING_1,
+            thematicBreak: true,
+        });
     }
 
     public createSubHeading(text: string): Paragraph {
-        return new Paragraph(text).heading2();
+        return new Paragraph({
+            text: text,
+            heading: HeadingLevel.HEADING_2,
+        });
     }
 
     public createInstitutionHeader(institutionName: string, dateText: string): Paragraph {
-        const paragraph = new Paragraph().maxRightTabStop();
-        const institution = new TextRun(institutionName).bold();
-        const date = new TextRun(dateText).tab().bold();
-
-        paragraph.addRun(institution);
-        paragraph.addRun(date);
-
-        return 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 {
-        const paragraph = new Paragraph();
-        const role = new TextRun(roleText).italics();
-
-        paragraph.addRun(role);
-
-        return paragraph;
+        return new Paragraph({
+            children: [
+                new TextRun({
+                    text: roleText,
+                    italics: true,
+                }),
+            ],
+        });
     }
 
     public createBullet(text: string): Paragraph {
-        return new Paragraph(text).bullet();
+        return new Paragraph({
+            text: text,
+            bullet: {
+                level: 0,
+            },
+        });
     }
 
     // tslint:disable-next-line:no-any
     public createSkillList(skills: any[]): Paragraph {
-        const paragraph = new Paragraph();
-        const skillConcat = skills.map((skill) => skill.name).join(", ") + ".";
-
-        paragraph.addRun(new TextRun(skillConcat));
-
-        return paragraph;
+        return new Paragraph({
+            children: [new TextRun(skills.map((skill) => skill.name).join(", ") + ".")],
+        });
     }
 
     // tslint:disable-next-line:no-any
     public createAchivementsList(achivements: any[]): Paragraph[] {
-        const arr: Paragraph[] = [];
-
-        for (const achievement of achivements) {
-            const paragraph = new Paragraph(achievement.name).bullet();
-            arr.push(paragraph);
-        }
-
-        return arr;
+        return achivements.map(
+            (achievement) =>
+                new Paragraph({
+                    text: achievement.name,
+                    bullet: {
+                        level: 0,
+                    },
+                }),
+        );
     }
 
     public createInterests(interests: string): Paragraph {
-        const paragraph = new Paragraph();
-
-        paragraph.addRun(new TextRun(interests));
-        return paragraph;
+        return new Paragraph({
+            children: [new TextRun(interests)],
+        });
     }
 
     public splitParagraphIntoBullets(text: string): string[] {
@@ -321,8 +339,6 @@ const documentCreator = new DocumentCreator();
 
 const doc = documentCreator.create([experiences, education, skills, achievements]);
 
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/11-declaritive-styles-2.ts

@@ -0,0 +1,263 @@
+// Setting styles with JavaScript configuration
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    Document,
+    Footer,
+    HeadingLevel,
+    Media,
+    Packer,
+    Paragraph,
+    Table,
+    TableCell,
+    TableRow,
+    TabStopPosition,
+    UnderlineType,
+} from "../build";
+
+const doc = new Document({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "Heading1",
+                name: "Heading 1",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 52,
+                    bold: true,
+                    color: "000000",
+                    underline: {
+                        type: UnderlineType.SINGLE,
+                        color: "000000",
+                    },
+                },
+                paragraph: {
+                    alignment: AlignmentType.CENTER,
+                    spacing: { line: 340 },
+                },
+            },
+            {
+                id: "Heading2",
+                name: "Heading 2",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 340 },
+                },
+            },
+            {
+                id: "Heading3",
+                name: "Heading 3",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 276 },
+                },
+            },
+            {
+                id: "Heading4",
+                name: "Heading 4",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    alignment: AlignmentType.JUSTIFIED,
+                },
+            },
+            {
+                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: 720 },
+                },
+            },
+            {
+                id: "wellSpaced",
+                name: "Well Spaced",
+                basedOn: "Normal",
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                },
+            },
+            {
+                id: "ListParagraph",
+                name: "List Paragraph",
+                basedOn: "Normal",
+                quickFormat: true,
+            },
+        ],
+    },
+});
+
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+
+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 image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+
+doc.addSection({
+    properties: {
+        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(image),
+        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(image1),
+        new Paragraph({
+            text: "Test",
+            style: "normalPara2",
+        }),
+        new Paragraph(image2),
+        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,19 @@
+// Scaling images
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Media, Packer, Paragraph } from "../build";
+
+const doc = new Document();
+
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 50, 50);
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 100, 100);
+const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 250, 250);
+const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 400, 400);
+
+doc.addSection({
+    children: [new Paragraph("Hello World"), new Paragraph(image), new Paragraph(image2), new Paragraph(image3), new Paragraph(image4)],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/13-xml-styles.ts

@@ -0,0 +1,32 @@
+// 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,
+});
+
+doc.addSection({
+    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,47 @@
+// Page numbers
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "../build";
+
+const doc = new Document();
+
+doc.addSection({
+    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"),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/15-page-break-before.ts

@@ -5,14 +5,16 @@ import { Document, Packer, Paragraph } from "../build";
 
 const doc = new Document();
 
-const paragraph = new Paragraph("Hello World");
-const paragraph2 = new Paragraph("Hello World on another page").pageBreakBefore();
+doc.addSection({
+    children: [
+        new Paragraph("Hello World"),
+        new Paragraph({
+            text: "Hello World on another page",
+            pageBreakBefore: true,
+        }),
+    ],
+});
 
-doc.addParagraph(paragraph);
-doc.addParagraph(paragraph2);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/16-multiple-sections.ts

@@ -0,0 +1,124 @@
+// 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();
+
+doc.addSection({
+    children: [new Paragraph("Hello World")],
+});
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [new Paragraph("First Default Header on another page")],
+        }),
+    },
+    footers: {
+        default: new Footer({
+            children: [new Paragraph("Footer on another page")],
+        }),
+    },
+    properties: {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+    children: [new Paragraph("hello")],
+});
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [new Paragraph("Second Default Header on another page")],
+        }),
+    },
+    footers: {
+        default: new Footer({
+            children: [new Paragraph("Footer on another page")],
+        }),
+    },
+    size: {
+        orientation: PageOrientation.LANDSCAPE,
+    },
+    properties: {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+    children: [new Paragraph("hello in landscape")],
+});
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            children: ["Page number: ", PageNumber.CURRENT],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    },
+    size: {
+        orientation: PageOrientation.PORTRAIT,
+    },
+    children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
+});
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            children: ["Page number: ", PageNumber.CURRENT],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    },
+    properties: {
+        pageNumberFormatType: PageNumberFormat.UPPER_ROMAN,
+        orientation: PageOrientation.PORTRAIT,
+    },
+    children: [
+        new Paragraph(
+            "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
+        ),
+    ],
+});
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            children: ["Page number: ", PageNumber.CURRENT],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    },
+    size: {
+        orientation: PageOrientation.PORTRAIT,
+    },
+    properties: {
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+        pageNumberStart: 25,
+    },
+    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: [
+        new Paragraph("Foo"),
+        new Paragraph("Test"),
+        new Paragraph("My amazing reference"),
+        new Paragraph("Foo1"),
+        new Paragraph("Test1"),
+        new Paragraph("My amazing reference1"),
+    ],
+});
+
+doc.addSection({
+    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)],
+        }),
+    ],
+});
+
+doc.addSection({
+    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

@@ -1,17 +1,22 @@
 // Insert image from a buffer
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer } from "../build";
+import { Document, Media, Packer, Paragraph } from "../build";
 
 const doc = new Document();
 
 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`;
 
-// doc.createImage(Buffer.from(imageBase64Data, 'base64'));
-doc.createImage(Buffer.from(imageBase64Data, "base64"), 100, 100);
+const image = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);
 
-const packer = new Packer();
+doc.addSection({
+    children: [
+        new Paragraph({
+            children: [image],
+        }),
+    ],
+});
 
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/19-export-to-base64.ts

@@ -0,0 +1,28 @@
+// 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();
+
+doc.addSection({
+    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,178 @@
+// 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, Document, HeadingLevel, Packer, Paragraph, TextRun, UnderlineType } from "../build";
+
+const doc = new Document({
+    creator: "Clippy",
+    title: "Sample Document",
+    description: "A brief example of using docx",
+    styles: {
+        paragraphStyles: [
+            {
+                id: "Heading1",
+                name: "Heading 1",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    size: 28,
+                    bold: true,
+                    italics: true,
+                    color: "red",
+                },
+                paragraph: {
+                    spacing: {
+                        after: 120,
+                    },
+                },
+            },
+            {
+                id: "Heading2",
+                name: "Heading 2",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    size: 26,
+                    bold: true,
+                    underline: {
+                        type: UnderlineType.DOUBLE,
+                        color: "FF0000",
+                    },
+                },
+                paragraph: {
+                    spacing: {
+                        before: 240,
+                        after: 120,
+                    },
+                },
+            },
+            {
+                id: "aside",
+                name: "Aside",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "999999",
+                    italics: true,
+                },
+                paragraph: {
+                    indent: {
+                        left: 720,
+                    },
+                    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 },
+                },
+            },
+            {
+                id: "ListParagraph",
+                name: "List Paragraph",
+                basedOn: "Normal",
+                quickFormat: true,
+            },
+        ],
+    },
+    numbering: {
+        config: [
+            {
+                reference: "my-crazy-numbering",
+                levels: [
+                    {
+                        level: 0,
+                        format: "lowerLetter",
+                        text: "%1)",
+                        alignment: AlignmentType.LEFT,
+                    },
+                ],
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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,
+            },
+        }),
+        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.",
+                }),
+            ],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/20-table-cell-borders.ts

@@ -0,0 +1,103 @@
+// 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();
+
+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("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: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({ children: [table] });
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/21-bookmarks.ts

@@ -1,37 +1,40 @@
 // 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 { Document, Packer } from "../build";
+import { Bookmark, Document, HeadingLevel, HyperlinkRef, HyperlinkType, Packer, PageBreak, Paragraph } from "../build";
 
-const loremIpsum =
+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",
+    hyperlinks: {
+        myAnchorId: {
+            text: "Hyperlink",
+            type: HyperlinkType.INTERNAL,
+        },
+    },
 });
 
-const anchorId = "anchorID";
+doc.addSection({
+    children: [
+        new Paragraph({
+            heading: HeadingLevel.HEADING_1,
+            children: [new Bookmark("myAnchorId", "Lorem Ipsum")],
+        }),
+        new Paragraph("\n"),
+        new Paragraph(LOREM_IPSUM),
+        new Paragraph({
+            children: [new PageBreak()],
+        }),
+        new Paragraph({
+            children: [new HyperlinkRef("myAnchorId")],
+        }),
+    ],
+});
 
-// First create the bookmark
-const bookmark = doc.createBookmark(anchorId, "Lorem Ipsum");
-// That has header styling
-doc
-    .createParagraph()
-    .addBookmark(bookmark)
-    .heading1();
-doc.createParagraph("\n");
-
-doc.createParagraph(loremIpsum);
-doc.createParagraph().pageBreak();
-
-// Now the link back up to the bookmark
-const hyperlink = doc.createInternalHyperLink(anchorId, `Click me!`);
-doc.createParagraph().addHyperLink(hyperlink);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

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

@@ -0,0 +1,44 @@
+// 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, TextRun } from "../build";
+
+const doc = new Document();
+
+doc.addSection({
+    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,
+                }),
+            ],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/23-base64-images.ts

@@ -1,13 +1,10 @@
 // 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, Media, Packer, Paragraph } from "../build";
+import { Document, Media, Packer, Paragraph, TextRun } from "../build";
 
 const doc = new Document();
 
-const paragraph = new Paragraph("Hello World");
-doc.addParagraph(paragraph);
-
 const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
 const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png"));
 const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
@@ -17,18 +14,19 @@ const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
 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 image6 = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);
 
-// I am adding an image to the paragraph rather than the document to make the image inline
-paragraph.addImage(image5);
+doc.addSection({
+    children: [
+        new Paragraph({
+            children: [new TextRun("Hello World"), image5],
+        }),
+        new Paragraph(image),
+        new Paragraph(image2),
+        new Paragraph(image3),
+        new Paragraph(image4),
+        new Paragraph(image6),
+    ],
+});
 
-doc.addImage(image);
-doc.addImage(image2);
-doc.addImage(image3);
-doc.addImage(image4);
-doc.addImage(image5);
-doc.addImage(image6);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

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

@@ -0,0 +1,85 @@
+// Add image to table cell
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Media, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const doc = new Document();
+
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+
+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(image)],
+                }),
+                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: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [table],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/26-paragraph-borders.ts

@@ -0,0 +1,33 @@
+// 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();
+
+doc.addSection({
+    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,67 @@
+// Custom styles using JavaScript configuration
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, 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: 720,
+                    },
+                    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,
+                    },
+                },
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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";
+
+const doc = new File({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "MySpectacularStyle",
+                name: "My Spectacular Style",
+                basedOn: "Heading1",
+                next: "Heading1",
+                quickFormat: true,
+                run: {
+                    italics: true,
+                    color: "990000",
+                },
+            },
+        ],
+    },
+});
+
+// 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
+
+doc.addSection({
+    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,117 @@
+// Numbered lists
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: "upperRoman",
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 720, hanging: 260 },
+                            },
+                        },
+                    },
+                ],
+                reference: "my-crazy-reference",
+            },
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: "decimal",
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 720, hanging: 260 },
+                            },
+                        },
+                    },
+                ],
+                reference: "my-number-numbering-reference",
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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,
+            },
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -0,0 +1,142 @@
+// Numbering and bullet points example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                reference: "my-crazy-numbering",
+                levels: [
+                    {
+                        level: 0,
+                        format: "upperRoman",
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 720, hanging: 260 },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: "decimal",
+                        text: "%2.",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 1440, hanging: 980 },
+                            },
+                        },
+                    },
+                    {
+                        level: 2,
+                        format: "lowerLetter",
+                        text: "%3)",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2160, hanging: 1700 },
+                            },
+                        },
+                    },
+                    {
+                        level: 3,
+                        format: "upperLetter",
+                        text: "%4)",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2880, hanging: 2420 },
+                            },
+                        },
+                    },
+                ],
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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,
+            },
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/30-template-document.ts

@@ -12,19 +12,18 @@ fs.readFile(filePath, (err, data) => {
     }
 
     importDotx.extract(data).then((templateDocument) => {
-        // This any needs fixing
-        const sectionProps = {
-            titlePage: templateDocument.titlePageIsDefined,
-        } as any;
-
-        const doc = new Document(undefined, sectionProps, {
+        const doc = new Document(undefined, {
             template: templateDocument,
         });
-        const paragraph = new Paragraph("Hello World");
-        doc.addParagraph(paragraph);
 
-        const packer = new Packer();
-        packer.toBuffer(doc).then((buffer) => {
+        doc.addSection({
+            properties: {
+                titlePage: templateDocument.titlePageIsDefined,
+            },
+            children: [new Paragraph("Hello World")],
+        });
+
+        Packer.toBuffer(doc).then((buffer) => {
             fs.writeFileSync("My Document.docx", buffer);
         });
     });

demo/31-tables.ts

@@ -0,0 +1,76 @@
+// 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();
+
+const table = 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,
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [table],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -0,0 +1,397 @@
+// 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, Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, TableCell, TableRow, WidthType } from "../build";
+
+const doc = new Document();
+
+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: 1000,
+                        bottom: 1000,
+                        left: 1000,
+                        right: 1000,
+                    },
+                    columnSpan: 3,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+                new TableCell({
+                    children: [],
+                }),
+            ],
+        }),
+    ],
+    width: {
+        size: 100,
+        type: WidthType.AUTO,
+    },
+    columnWidths: [1000, 1000, 1000],
+});
+
+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: 7000,
+        type: WidthType.DXA,
+    },
+    margins: {
+        top: 400,
+        bottom: 400,
+        right: 400,
+        left: 400,
+    },
+});
+
+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,
+    },
+});
+
+doc.addSection({
+    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,47 @@
+// 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();
+
+doc.addSection({
+    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,62 @@
+// 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 doc = new Document();
+
+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,
+    },
+    width: {
+        size: 4535,
+        type: WidthType.DXA,
+    },
+    layout: TableLayoutType.FIXED,
+});
+
+doc.addSection({
+    children: [table],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/35-hyperlinks.ts

@@ -0,0 +1,36 @@
+// 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, HyperlinkRef, HyperlinkType, Packer, Paragraph, Media } from "../build";
+
+const doc = new Document({
+    hyperlinks: {
+        myCoolLink: {
+            link: "http://www.example.com",
+            text: "Hyperlink",
+            type: HyperlinkType.EXTERNAL,
+        },
+        myOtherLink: {
+            link: "http://www.google.com",
+            text: "Google Link",
+            type: HyperlinkType.EXTERNAL,
+        },
+    },
+});
+
+const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+
+doc.addSection({
+    children: [
+        new Paragraph({
+            children: [new HyperlinkRef("myCoolLink")],
+        }),
+        new Paragraph({
+            children: [image1, new HyperlinkRef("myOtherLink")],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -0,0 +1,72 @@
+// 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, Media, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+
+const doc = new Document();
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+
+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(image)],
+                }),
+            ],
+        }),
+        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
+doc.addSection({
+    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,22 @@
+// 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, Media, Packer, Paragraph } from "../build";
+
+const doc = new Document();
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [new Paragraph(image), new Paragraph(image1), new Paragraph(image2)],
+        }),
+    },
+    children: [new Paragraph("Hello World")],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/38-text-wrapping.ts

@@ -0,0 +1,45 @@
+// 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, Media, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build";
+
+const doc = new Document();
+
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 2014400,
+        },
+        verticalPosition: {
+            offset: 2014400,
+        },
+        wrap: {
+            type: TextWrappingType.SQUARE,
+            side: TextWrappingSide.BOTH_SIDES,
+        },
+        margins: {
+            top: 201440,
+            bottom: 201440,
+        },
+    },
+});
+
+doc.addSection({
+    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(image),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/39-page-numbers.ts

@@ -0,0 +1,69 @@
+// 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({});
+
+doc.addSection({
+    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],
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    },
+    properties: {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+    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,39 @@
+// 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 } from "../build";
+
+const doc = new Document();
+
+const table = 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")],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [table],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/40-line-numbers.ts

@@ -0,0 +1,29 @@
+// 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();
+
+doc.addSection({
+    properties: {
+        lineNumberCountBy: 1,
+        lineNumberRestart: 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,261 @@
+// 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 doc = new Document();
+
+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: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [table, new Paragraph(""), table2],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -0,0 +1,84 @@
+// 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 doc = new Document();
+
+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: [],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [table],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/44-multiple-columns.ts

@@ -0,0 +1,40 @@
+// 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();
+
+doc.addSection({
+    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.",
+        ),
+    ],
+});
+
+doc.addSection({
+    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.",
+        ),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/45-highlighting-text.ts

@@ -0,0 +1,35 @@
+// 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();
+
+doc.addSection({
+    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,39 @@
+// 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();
+
+doc.addSection({
+    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",
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        }),
+    },
+    children: [],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -0,0 +1,67 @@
+// 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 doc = new Document();
+
+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. ")],
+});
+
+doc.addSection({
+    headers: {
+        default: header,
+    },
+    footers: {
+        default: footer,
+    },
+    properties: {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+    children: [
+        new Paragraph({
+            children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
+        }),
+    ],
+});
+
+doc.addSection({
+    headers: {
+        default: header,
+    },
+    footers: {
+        default: footer,
+    },
+    properties: {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+    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,31 @@
+// 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();
+
+doc.addSection({
+    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,37 @@
+// Add custom borders to the table itself
+// 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();
+
+const table = 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")],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({ children: [table] });
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/5-images.ts

@@ -0,0 +1,62 @@
+// 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, Packer, Paragraph } from "../build";
+import {
+    Document,
+    HorizontalPositionAlign,
+    HorizontalPositionRelativeFrom,
+    Media,
+    Packer,
+    Paragraph,
+    VerticalPositionAlign,
+    VerticalPositionRelativeFrom,
+} from "../build";
+
+const doc = new Document();
+
+const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png").toString("base64"));
+const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
+const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp"));
+const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+const image6 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 1014400,
+        },
+        verticalPosition: {
+            offset: 1014400,
+        },
+    },
+});
+
+const image7 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            relative: HorizontalPositionRelativeFrom.PAGE,
+            align: HorizontalPositionAlign.RIGHT,
+        },
+        verticalPosition: {
+            relative: VerticalPositionRelativeFrom.PAGE,
+            align: VerticalPositionAlign.BOTTOM,
+        },
+    },
+});
+
+doc.addSection({
+    children: [
+        new Paragraph("Hello World"),
+        new Paragraph(image1),
+        new Paragraph(image2),
+        new Paragraph(image3),
+        new Paragraph(image4),
+        new Paragraph(image5),
+        new Paragraph(image6),
+        new Paragraph(image7),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/50-readme-demo.ts

@@ -0,0 +1,61 @@
+// 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, HeadingLevel, Media, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
+
+const doc = new Document();
+
+const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph(image1)],
+                    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(image1)],
+                }),
+            ],
+        }),
+    ],
+});
+
+doc.addSection({
+    children: [
+        new Paragraph({
+            text: "Hello World",
+            heading: HeadingLevel.HEADING_1,
+        }),
+        table,
+        new Paragraph(image2),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/51-character-styles.ts

@@ -0,0 +1,37 @@
+// 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,
+                },
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    children: [
+        new Paragraph({
+            children: [
+                new TextRun({
+                    text: "Foo bar",
+                    style: "myRedStyle",
+                }),
+            ],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/52-japanese.ts

@@ -0,0 +1,37 @@
+// 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",
+                },
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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,55 @@
+// 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: {
+        paragraphStyles: [
+            {
+                id: "Normal",
+                name: "Normal",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: {
+                        ascii: "Times",
+                        eastAsia: "KaiTi",
+                    },
+                },
+            },
+        ],
+    },
+});
+
+doc.addSection({
+    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
+                }),
+            ],
+        }),
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/6-page-borders.ts

@@ -0,0 +1,40 @@
+// 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();
+
+doc.addSection({
+    margins: {
+        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/7-landscape.ts

@@ -3,16 +3,15 @@
 import * as fs from "fs";
 import { Document, Packer, PageOrientation, Paragraph } from "../build";
 
-const doc = new Document(undefined, {
-    orientation: PageOrientation.LANDSCAPE,
+const doc = new Document();
+
+doc.addSection({
+    size: {
+        orientation: PageOrientation.LANDSCAPE,
+    },
+    children: [new Paragraph("Hello World")],
 });
 
-const paragraph = new Paragraph("Hello World");
-
-doc.addParagraph(paragraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
+Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/8-header-footer.ts

@@ -0,0 +1,24 @@
+// 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();
+
+doc.addSection({
+    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,35 @@
+// 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, Media, Packer, Paragraph } from "../build";
+
+const doc = new Document();
+
+const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+
+doc.addSection({
+    headers: {
+        default: new Header({
+            children: [
+                new Paragraph({
+                    children: [image1],
+                }),
+            ],
+        }),
+    },
+    footers: {
+        default: new Footer({
+            children: [
+                new Paragraph({
+                    children: [image2],
+                }),
+            ],
+        }),
+    },
+    children: [new Paragraph("Hello World")],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/browser-demo.html

@@ -1,39 +1,45 @@
 <!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>
 
-<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>
 
-<body>
+        <button type="button" onclick="generate()">Click to generate document</button>
 
-    <h1>DOCX browser Word document generation</h1>
+        <script>
+            function generate() {
+                const doc = new docx.Document();
 
-    <button type="button" onclick="generate()">Click to generate document</button>
+                doc.addSection({
+                    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,
+                                }),
+                            ],
+                        }),
+                    ],
+                });
 
-    <script>
-        function generate() {
-            const doc = new Document();
 
-            const paragraph = new Paragraph("Hello World");
-            const institutionText = new TextRun("Foo Bar").bold();
-            const dateText = new TextRun("Github is the best").tab().bold();
-            paragraph.addRun(institutionText);
-            paragraph.addRun(dateText);
-
-            doc.addParagraph(paragraph);
-
-            const packer = new Packer();
-
-            packer.toBlob(doc).then(blob => {
-                console.log(blob);
-                saveAs(blob, "example.docx");
-                console.log("Document created successfully");
-            });
-        }
-    </script>
-
-</body>
 
+                docx.Packer.toBlob(doc).then((blob) => {
+                    console.log(blob);
+                    saveAs(blob, "example.docx");
+                    console.log("Document created successfully");
+                });
+            }
+        </script>
+    </body>
 </html>

demo/demo1.ts

@@ -1,20 +0,0 @@
-// 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();
-
-const paragraph = new Paragraph("Hello World");
-const institutionText = new TextRun("Foo Bar").bold();
-const dateText = new TextRun("Github is the best").tab().bold();
-paragraph.addRun(institutionText);
-paragraph.addRun(dateText);
-
-doc.addParagraph(paragraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo11.ts

@@ -1,140 +0,0 @@
-// Setting styles with JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Packer, Paragraph, Table } from "../build";
-
-const doc = new Document(undefined, {
-    top: 700,
-    right: 700,
-    bottom: 700,
-    left: 700,
-});
-
-doc.Styles.createParagraphStyle("Heading1", "Heading 1")
-    .basedOn("Normal")
-    .next("Normal")
-    .quickFormat()
-    .font("Calibri")
-    .size(52)
-    .center()
-    .bold()
-    .color("000000")
-    .spacing({ line: 340 })
-    .underline("single", "000000");
-
-doc.Styles.createParagraphStyle("Heading2", "Heading 2")
-    .basedOn("Normal")
-    .next("Normal")
-    .font("Calibri")
-    .quickFormat()
-    .size(26)
-    .bold()
-    .spacing({ line: 340 });
-
-doc.Styles.createParagraphStyle("Heading3", "Heading 3")
-    .basedOn("Normal")
-    .next("Normal")
-    .font("Calibri")
-    .quickFormat()
-    .size(26)
-    .bold()
-    .spacing({ line: 276 });
-
-doc.Styles.createParagraphStyle("Heading4", "Heading 4")
-    .basedOn("Normal")
-    .next("Normal")
-    .justified()
-    .font("Calibri")
-    .size(26)
-    .bold();
-
-doc.Styles.createParagraphStyle("normalPara", "Normal Para")
-    .basedOn("Normal")
-    .next("Normal")
-    .font("Calibri")
-    .quickFormat()
-    .leftTabStop(453.543307087)
-    .maxRightTabStop()
-    .size(26)
-    .spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
-
-doc.Styles.createParagraphStyle("normalPara2", "Normal Para2")
-    .basedOn("Normal")
-    .next("Normal")
-    .quickFormat()
-    .font("Calibri")
-    .size(26)
-    .justified()
-    .spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
-
-doc.Styles.createParagraphStyle("aside", "Aside")
-    .basedOn("Normal")
-    .next("Normal")
-    .color("999999")
-    .italics()
-    .indent({ left: 720 })
-    .spacing({ line: 276 });
-
-doc.Styles.createParagraphStyle("wellSpaced", "Well Spaced")
-    .basedOn("Normal")
-    .spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 });
-
-doc.Styles.createParagraphStyle("ListParagraph", "List Paragraph")
-    .quickFormat()
-    .basedOn("Normal");
-
-doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-doc.createParagraph("HEADING")
-    .heading1()
-    .center();
-
-doc.Footer.createParagraph("1")
-    .style("normalPara")
-    .right();
-
-doc.createParagraph("Ref. :").style("normalPara");
-doc.createParagraph("Date :").style("normalPara");
-
-doc.createParagraph("To,").style("normalPara");
-doc.createParagraph("The Superindenting Engineer,(O &M)").style("normalPara");
-
-doc.createParagraph("Sub : ").style("normalPara");
-
-doc.createParagraph("Ref. : ").style("normalPara");
-
-doc.createParagraph("Sir,").style("normalPara");
-
-doc.createParagraph("BRIEF DESCRIPTION").style("normalPara");
-
-const table = new Table({
-    rows: 4,
-    columns: 4,
-});
-table
-    .getRow(0)
-    .getCell(0)
-    .addParagraph(new Paragraph("Pole No."));
-
-doc.addTable(table);
-
-const arrboth = [
-    {
-        image: "./demo/images/pizza.gif",
-        comment: "Test",
-    },
-    {
-        image: "./demo/images/pizza.gif",
-        comment: "Test 2",
-    },
-];
-
-arrboth.forEach((item) => {
-    doc.createImage(fs.readFileSync(item.image));
-    doc.createParagraph(item.comment).style("normalPara2");
-});
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo12.ts

@@ -1,25 +0,0 @@
-// Scaling images
-// 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();
-
-const paragraph = new Paragraph("Hello World");
-doc.addParagraph(paragraph);
-
-const image = doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-const image2 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-const image3 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-const image4 = doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-
-image.scale(0.5);
-image2.scale(1);
-image3.scale(2.5);
-image4.scale(4);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo13.ts

@@ -1,28 +0,0 @@
-// 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, Packer, Paragraph } from "../build";
-
-const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
-const doc = new Document({
-    title: "Title",
-    externalStyles: styles,
-});
-
-doc.createParagraph("Cool Heading Text").heading1();
-
-const paragraph = new Paragraph('This is a custom named style from the template "MyFancyStyle"');
-paragraph.style("MyFancyStyle");
-doc.addParagraph(paragraph);
-
-doc.createParagraph("Some normal text");
-
-doc.createParagraph("MyFancyStyle again").style("MyFancyStyle");
-paragraph.style("MyFancyStyle");
-doc.addParagraph(paragraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo14.ts

@@ -1,28 +0,0 @@
-// Page numbers
-// 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();
-
-doc.createParagraph("First Page").pageBreak();
-doc.createParagraph("Second Page");
-
-const pageNumber = new TextRun("Page ").pageNumber();
-
-const pageoneheader = new Paragraph("First Page Header ").right();
-
-pageoneheader.addRun(pageNumber);
-const firstPageHeader = doc.createFirstPageHeader();
-firstPageHeader.addParagraph(pageoneheader);
-
-const pagetwoheader = new Paragraph("My Title ").right();
-
-pagetwoheader.addRun(pageNumber);
-doc.Header.addParagraph(pagetwoheader);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo16.ts

@@ -1,84 +0,0 @@
-// Multiple sections and headers
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Packer, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
-
-const doc = new Document();
-
-const paragraph = new Paragraph("Hello World").pageBreak();
-
-doc.addParagraph(paragraph);
-
-const header = doc.createHeader();
-header.createParagraph("Header on another page");
-const footer = doc.createFooter();
-footer.createParagraph("Footer on another page");
-
-doc.addSection({
-    headers: {
-        default: header,
-    },
-    footers: {
-        default: footer,
-    },
-    pageNumberStart: 1,
-    pageNumberFormatType: PageNumberFormat.DECIMAL,
-});
-
-doc.createParagraph("hello");
-
-doc.addSection({
-    headers: {
-        default: header,
-    },
-    footers: {
-        default: footer,
-    },
-    pageNumberStart: 1,
-    pageNumberFormatType: PageNumberFormat.DECIMAL,
-    orientation: PageOrientation.LANDSCAPE,
-});
-
-doc.createParagraph("hello in landscape");
-
-const header2 = doc.createHeader();
-const pageNumber = new TextRun("Page number: ").pageNumber();
-header2.createParagraph().addRun(pageNumber);
-
-doc.addSection({
-    headers: {
-        default: header2,
-    },
-    orientation: PageOrientation.PORTRAIT,
-});
-
-doc.createParagraph("Page number in the header must be 2, because it continues from the previous section.");
-
-doc.addSection({
-    headers: {
-        default: header2,
-    },
-    pageNumberFormatType: PageNumberFormat.UPPER_ROMAN,
-    orientation: PageOrientation.PORTRAIT,
-});
-
-doc.createParagraph(
-    "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
-);
-
-doc.addSection({
-    headers: {
-        default: header2,
-    },
-    pageNumberFormatType: PageNumberFormat.DECIMAL,
-    pageNumberStart: 25,
-    orientation: PageOrientation.PORTRAIT,
-});
-
-doc.createParagraph("Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section.");
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo17.ts

@@ -1,21 +0,0 @@
-// Footnotes
-// 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();
-
-const paragraph = new Paragraph("Hello World").referenceFootnote(1);
-const paragraph2 = new Paragraph("Hello World").referenceFootnote(2);
-
-doc.addParagraph(paragraph);
-doc.addParagraph(paragraph2);
-
-doc.createFootnote(new Paragraph("Test"));
-doc.createFootnote(new Paragraph("My amazing reference"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo19.ts

@@ -1,20 +0,0 @@
-// 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();
-
-const paragraph = new Paragraph("Hello World");
-const institutionText = new TextRun("Foo").bold();
-const dateText = new TextRun("Bar").tab().bold();
-paragraph.addRun(institutionText);
-paragraph.addRun(dateText);
-
-doc.addParagraph(paragraph);
-
-const packer = new Packer();
-
-packer.toBase64String(doc).then((str) => {
-    fs.writeFileSync("My Document.docx", str);
-});

demo/demo2.ts

@@ -1,78 +0,0 @@
-// 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 { Document, Packer } from "../build";
-
-const doc = new 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({ left: 720 })
-    .spacing({ line: 276 });
-
-doc.Styles.createParagraphStyle("wellSpaced", "Well Spaced")
-    .basedOn("Normal")
-    .spacing({ line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.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 packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo20.ts

@@ -1,24 +0,0 @@
-// 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 } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 4,
-    columns: 4,
-});
-table
-    .getCell(2, 2)
-    .addParagraph(new Paragraph("Hello"))
-    .Borders.addTopBorder(BorderStyle.DASH_DOT_STROKED, 3, "red")
-    .addBottomBorder(BorderStyle.DOUBLE, 3, "blue")
-    .addStartBorder(BorderStyle.DOT_DOT_DASH, 3, "green")
-    .addEndBorder(BorderStyle.DOT_DOT_DASH, 3, "#ff8000");
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo22.ts

@@ -1,27 +0,0 @@
-// 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, TextRun } from "../build";
-
-const doc = new Document();
-
-const paragraph1 = new Paragraph().bidirectional();
-const textRun1 = new TextRun("שלום עולם").rightToLeft();
-paragraph1.addRun(textRun1);
-doc.addParagraph(paragraph1);
-
-const paragraph2 = new Paragraph().bidirectional();
-const textRun2 = new TextRun("שלום עולם").bold().rightToLeft();
-paragraph2.addRun(textRun2);
-doc.addParagraph(paragraph2);
-
-const paragraph3 = new Paragraph().bidirectional();
-const textRun3 = new TextRun("שלום עולם").italics().rightToLeft();
-paragraph3.addRun(textRun3);
-doc.addParagraph(paragraph3);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo24.ts

@@ -1,21 +0,0 @@
-// Add image to table cell
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Media, Packer, Paragraph } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 4,
-    columns: 4,
-});
-table.getCell(2, 2).addParagraph(new Paragraph("Hello"));
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-table.getCell(1, 1).addParagraph(image.Paragraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo26.ts

@@ -1,22 +0,0 @@
-// 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();
-
-const paragraph = new Paragraph("No border!");
-
-doc.addParagraph(paragraph);
-
-const borderParagraph = new Paragraph("I have borders on my top and bottom sides!").createBorder();
-borderParagraph.Borders.addTopBorder();
-borderParagraph.Borders.addBottomBorder();
-
-doc.addParagraph(borderParagraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo27.ts

@@ -1,35 +0,0 @@
-// Custom styles using JavaScript configuration
-// 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();
-const myStyles = doc.Styles;
-
-// The first argument is an ID you use to apply the style to paragraphs
-// The second argument is a human-friendly name to show in the UI
-myStyles.createParagraphStyle("myWonkyStyle", "My Wonky Style")
-    .basedOn("Normal")
-    .next("Normal")
-    .color("990000")
-    .italics()
-    .indent({left: 720})  // 720 TWIP === 720 / 20 pt === .5 in
-    .spacing({line: 276});  // 276 / 240 = 1.15x line spacing
-
-myStyles.createParagraphStyle("Heading2", "Heading 2")
-    .basedOn("Normal")
-    .next("Normal")
-    .quickFormat()
-    .size(26)  // 26 half-points === 13pt font
-    .bold()
-    .underline("double", "FF0000")
-    .spacing({before: 240, after: 120});  // TWIP for both
-
-doc.createParagraph("Hello").style("myWonkyStyle");
-doc.createParagraph("World").heading2(); // Uses the Heading2 style
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo28.ts

@@ -1,43 +0,0 @@
-// Table of contents
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { File, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
-
-const doc = new File();
-
-// The first argument is an ID you use to apply the style to paragraphs
-// The second argument is a human-friendly name to show in the UI
-doc.Styles.createParagraphStyle("MySpectacularStyle", "My Spectacular Style")
-    .basedOn("Heading1")
-    .next("Heading1")
-    .color("990000")
-    .italics();
-
-// 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 toc = new TableOfContents("Summary", {
-    hyperlink: true,
-    headingStyleRange: "1-5",
-    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
-});
-
-doc.addTableOfContents(toc);
-
-doc.addParagraph(new Paragraph("Header #1").heading1().pageBreakBefore());
-doc.addParagraph(new Paragraph("I'm a little text very nicely written.'"));
-
-doc.addParagraph(new Paragraph("Header #2").heading1().pageBreakBefore());
-doc.addParagraph(new Paragraph("I'm a other text very nicely written.'"));
-doc.addParagraph(new Paragraph("Header #2.1").heading2());
-doc.addParagraph(new Paragraph("I'm a another text very nicely written.'"));
-
-doc.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore());
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo29.ts

@@ -1,46 +0,0 @@
-// Numbered lists
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Indent, Numbering, Packer, Paragraph } from "../build";
-
-const doc = new Document();
-
-const numbering = new Numbering();
-
-const abstractNum = numbering.createAbstractNumbering();
-abstractNum.createLevel(0, "upperRoman", "%1", "start").addParagraphProperty(new Indent({ left: 720, hanging: 260 }));
-
-const concrete = numbering.createConcreteNumbering(abstractNum);
-
-const item1 = new Paragraph("line with contextual spacing");
-const item2 = new Paragraph("line with contextual spacing");
-const item3 = new Paragraph("line without contextual spacing");
-const item4 = new Paragraph("line without contextual spacing");
-
-item1
-    .setNumbering(concrete, 0)
-    .spacing({ before: 200 })
-    .contextualSpacing(true);
-item2
-    .setNumbering(concrete, 0)
-    .spacing({ before: 200 })
-    .contextualSpacing(true);
-item3
-    .setNumbering(concrete, 0)
-    .spacing({ before: 200 })
-    .contextualSpacing(false);
-item4
-    .setNumbering(concrete, 0)
-    .spacing({ before: 200 })
-    .contextualSpacing(false);
-
-doc.addParagraph(item1);
-doc.addParagraph(item2);
-doc.addParagraph(item3);
-doc.addParagraph(item4);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo3.ts

@@ -1,46 +0,0 @@
-// Numbering and bullet points example
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Indent, Numbering, Packer, Paragraph } from "../build";
-
-const doc = new Document();
-
-const numbering = new Numbering();
-
-const abstractNum = numbering.createAbstractNumbering();
-abstractNum.createLevel(0, "upperRoman", "%1", "start").addParagraphProperty(new Indent({ left: 720, hanging: 260 }));
-abstractNum.createLevel(1, "decimal", "%2.", "start").addParagraphProperty(new Indent({ left: 1440, hanging: 980 }));
-abstractNum.createLevel(2, "lowerLetter", "%3)", "start").addParagraphProperty(new Indent({ left: 14402160, hanging: 1700 }));
-
-const concrete = numbering.createConcreteNumbering(abstractNum);
-
-const topLevelP = new Paragraph("Hey you");
-const subP = new Paragraph("What's up fam");
-const secondSubP = new Paragraph("Hello World 2");
-const subSubP = new 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);
-
-const bullet1 = new Paragraph("Hey you").bullet();
-const bullet2 = new Paragraph("What's up fam").bullet(1);
-const bullet3 = new Paragraph("Hello World 2").bullet(2);
-const bullet4 = new Paragraph("Yeah boi").bullet(3);
-
-doc.addParagraph(bullet1);
-doc.addParagraph(bullet2);
-doc.addParagraph(bullet3);
-doc.addParagraph(bullet4);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo31.ts

@@ -1,29 +0,0 @@
-// 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, VerticalAlign } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 2,
-    columns: 2,
-});
-table
-    .getCell(1, 1)
-    .addParagraph(new Paragraph("This text should be in the middle of the cell"))
-    .setVerticalAlign(VerticalAlign.CENTER);
-
-table
-    .getCell(1, 0)
-    .addParagraph(
-        new Paragraph(
-            "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",
-        ).heading1(),
-    );
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo32.ts

@@ -1,101 +0,0 @@
-// Example of how you would merge cells together
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Packer, Paragraph, ShadingType, WidthType } from "../build";
-
-const doc = new Document();
-
-let table = doc.createTable({
-    rows: 2,
-    columns: 2,
-});
-
-table.getCell(0, 0).addParagraph(new Paragraph("Hello"));
-table.getRow(0).mergeCells(0, 1);
-
-doc.createParagraph("Another table").heading2();
-
-table = doc.createTable({
-    rows: 2,
-    columns: 3,
-    width: 100,
-    widthUnitType: WidthType.AUTO,
-    columnWidths: [1000, 1000, 1000],
-});
-table
-    .getCell(0, 0)
-    .addParagraph(new Paragraph("World"))
-    .setMargins({
-        top: 1000,
-        bottom: 1000,
-        left: 1000,
-        right: 1000,
-    });
-table.getRow(0).mergeCells(0, 2);
-
-doc.createParagraph("Another table").heading2();
-
-table = doc.createTable({
-    rows: 2,
-    columns: 4,
-    width: 7000,
-    widthUnitType: WidthType.DXA,
-    margins: {
-        top: 400,
-        bottom: 400,
-        right: 400,
-        left: 400,
-    },
-});
-table.getCell(0, 0).addParagraph(new Paragraph("Foo"));
-table.getCell(0, 1).addParagraph(new Paragraph("v"));
-
-table
-    .getCell(1, 0)
-    .addParagraph(new Paragraph("Bar1"))
-    .setShading({
-        fill: "b79c2f",
-        val: ShadingType.REVERSE_DIAGONAL_STRIPE,
-        color: "auto",
-    });
-table
-    .getCell(1, 1)
-    .addParagraph(new Paragraph("Bar2"))
-    .setShading({
-        fill: "42c5f4",
-        val: ShadingType.PERCENT_95,
-        color: "auto",
-    });
-table
-    .getCell(1, 2)
-    .addParagraph(new Paragraph("Bar3"))
-    .setShading({
-        fill: "880aa8",
-        val: ShadingType.PERCENT_10,
-        color: "e2df0b",
-    });
-table
-    .getCell(1, 3)
-    .addParagraph(new Paragraph("Bar4"))
-    .setShading({
-        fill: "FF0000",
-        val: ShadingType.CLEAR,
-        color: "auto",
-    });
-
-table.getRow(0).mergeCells(0, 3);
-
-doc.createParagraph("hi");
-
-doc.createTable({
-    rows: 2,
-    columns: 2,
-    width: 100,
-    widthUnitType: WidthType.PERCENTAGE,
-});
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo33.ts

@@ -1,22 +0,0 @@
-// Sequential Captions
-// 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();
-
-const paragraph = new Paragraph("Hello World 1->").addSequentialIdentifier("Caption").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Caption");
-const paragraph2 = new Paragraph("Hello World 1->").addSequentialIdentifier("Label").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Label");
-const paragraph3 = new Paragraph("Hello World 1->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 3->")).addSequentialIdentifier("Label");
-const paragraph4 = new Paragraph("Hello World 2->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 4->")).addSequentialIdentifier("Label");
-
-doc.addParagraph(paragraph);
-doc.addParagraph(paragraph2);
-doc.addParagraph(paragraph3);
-doc.addParagraph(paragraph4);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo34.ts

@@ -1,29 +0,0 @@
-// 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, Packer, Paragraph, RelativeHorizontalPosition, RelativeVerticalPosition, TableAnchorType, WidthType } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 2,
-    columns: 2,
-    float: {
-        horizontalAnchor: TableAnchorType.MARGIN,
-        verticalAnchor: TableAnchorType.MARGIN,
-        relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
-        relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
-    },
-    width: 4535,
-    widthUnitType: WidthType.DXA,
-});
-table.setFixedWidthLayout();
-
-table.getCell(0, 0).addParagraph(new Paragraph("Hello"));
-table.getRow(0).mergeCells(0, 1);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo35.ts

@@ -1,18 +0,0 @@
-// 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, Packer, Paragraph } from "../build";
-
-const doc = new Document();
-const paragraph = new Paragraph();
-const link = doc.createHyperlink("http://www.example.com", "Hyperlink");
-
-link.bold();
-paragraph.addHyperLink(link);
-doc.addParagraph(paragraph);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo36.ts

@@ -1,26 +0,0 @@
-// Add image to table cell
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Media, Packer, Table } from "../build";
-
-const doc = new Document();
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-
-const table = new Table({
-    rows: 2,
-    columns: 2,
-});
-table.getCell(1, 1).addParagraph(image.Paragraph);
-
-// doc.createParagraph("Hello World");
-doc.addTable(table);
-
-// doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-doc.Header.addTable(table);
-// doc.Footer.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo37.ts

@@ -1,18 +0,0 @@
-// Add images to header and footer
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Media, Packer } from "../build";
-
-const doc = new Document();
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-doc.createParagraph("Hello World");
-
-doc.Header.addImage(image);
-doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-doc.Header.createImage(fs.readFileSync("./demo/images/image1.jpeg"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo38.ts

@@ -1,44 +0,0 @@
-// 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, Packer, TextWrappingSide, TextWrappingType } from "../build";
-
-const doc = new Document();
-
-doc.createParagraph(
-    "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.",
-);
-
-doc.createParagraph(
-    "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.",
-);
-
-doc.createParagraph(
-    "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.",
-);
-
-doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
-    floating: {
-        horizontalPosition: {
-            offset: 2014400,
-        },
-        verticalPosition: {
-            offset: 2014400,
-        },
-        wrap: {
-            type: TextWrappingType.SQUARE,
-            side: TextWrappingSide.BOTH_SIDES,
-        },
-        margins: {
-            top: 201440,
-            bottom: 201440,
-        },
-    },
-});
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo39.ts

@@ -1,33 +0,0 @@
-// Example how to display page numbers
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Packer, PageNumberFormat, TextRun } from "../build";
-
-const doc = new Document(
-    {},
-    {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
-);
-
-doc.Header.createParagraph("Foo Bar corp. ")
-    .addRun(new TextRun("Page Number ").pageNumber())
-    .addRun(new TextRun(" to ").numberOfTotalPages());
-
-doc.Footer.createParagraph("Foo Bar corp. ")
-    .center()
-    .addRun(new TextRun("Page Number: ").pageNumber())
-    .addRun(new TextRun(" to ").numberOfTotalPages());
-
-doc.createParagraph("Hello World 1").pageBreak();
-doc.createParagraph("Hello World 2").pageBreak();
-doc.createParagraph("Hello World 3").pageBreak();
-doc.createParagraph("Hello World 4").pageBreak();
-doc.createParagraph("Hello World 5").pageBreak();
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo4.ts

@@ -1,18 +0,0 @@
-// 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 } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 4,
-    columns: 4,
-});
-table.getCell(2, 2).addParagraph(new Paragraph("Hello"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo40.ts

@@ -1,26 +0,0 @@
-// Example demonstrating line numbers.
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, LineNumberRestartFormat, Packer, Paragraph } from "../build";
-
-const doc = new Document(
-    {},
-    {
-        lineNumberCountBy: 1,
-        lineNumberRestart: LineNumberRestartFormat.CONTINUOUS,
-    },
-);
-
-doc.addParagraph(new Paragraph("Hello").heading1());
-doc.createParagraph(
-    "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.",
-);
-doc.createParagraph(
-    "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.",
-);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo41.ts

@@ -1,51 +0,0 @@
-// Multiple cells merging in the same table
-// 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();
-
-const table = doc.createTable({
-    rows: 13,
-    columns: 6,
-});
-let row = 0;
-table.getCell(row, 0).addContent(new Paragraph("0,0"));
-table.getCell(row, 1).addContent(new Paragraph("0,1"));
-table.getCell(row, 3).addContent(new Paragraph("0,3"));
-table.getCell(row, 4).addContent(new Paragraph("0,4"));
-table.getRow(row).mergeCells(4, 5);
-table.getRow(row).mergeCells(1, 2);
-row = 1;
-table.getCell(row, 0).addContent(new Paragraph("1,0"));
-table.getCell(row, 2).addContent(new Paragraph("1,2"));
-table.getCell(row, 4).addContent(new Paragraph("1,4"));
-table.getRow(row).mergeCells(4, 5);
-table.getRow(row).mergeCells(2, 3);
-table.getRow(row).mergeCells(0, 1);
-
-row = 2;
-table.getCell(row, 0).addContent(new Paragraph("2,0"));
-table.getCell(row, 1).addContent(new Paragraph("2,1"));
-table.getCell(row, 2).addContent(new Paragraph("2,2"));
-table.getCell(row, 3).addContent(new Paragraph("2,3"));
-table.getCell(row, 4).addContent(new Paragraph("2,4"));
-table.getRow(row).mergeCells(4, 5);
-table.getRow(row).mergeCells(1, 2);
-row = 3;
-table.getCell(row, 0).addContent(new Paragraph("3,0"));
-table.getCell(row, 1).addContent(new Paragraph("3,1"));
-table.getCell(row, 2).addContent(new Paragraph("3,2"));
-table.getCell(row, 3).addContent(new Paragraph("3,3"));
-table.getCell(row, 4).addContent(new Paragraph("3,4"));
-table.getCell(row, 5).addContent(new Paragraph("3,5"));
-row = 4;
-table.getCell(row, 0).addContent(new Paragraph("4,0"));
-table.getCell(row, 5).addContent(new Paragraph("4,5"));
-table.getRow(row).mergeCells(0, 4);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo43.ts

@@ -1,20 +0,0 @@
-// 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 } from "../build";
-
-const doc = new Document();
-
-const table = doc.createTable({
-    rows: 4,
-    columns: 4,
-});
-table.getCell(2, 2).addParagraph(new Paragraph("Hello"));
-table.getColumn(3).mergeCells(1, 2);
-// table.getCell(3, 2).addParagraph(new Paragraph("Hello"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo44.ts

@@ -1,36 +0,0 @@
-// Sections with multiple columns
-// 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();
-
-doc.addSection({
-    column: {
-        width: 708,
-        count: 2,
-    },
-});
-
-doc.createParagraph("This text will be split into 2 columns on a page.");
-doc.createParagraph(
-    "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.",
-);
-
-doc.addSection({
-    column: {
-        width: 708,
-        count: 2,
-    },
-});
-
-doc.createParagraph("This text will be split into 3 columns on a page.");
-doc.createParagraph(
-    "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.",
-);
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo5.ts

@@ -1,45 +0,0 @@
-// 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, Packer, Paragraph } from "../build";
-import { Document, HorizontalPositionAlign, HorizontalPositionRelativeFrom, Packer, Paragraph, VerticalPositionAlign, VerticalPositionRelativeFrom} from "../build";
-
-const doc = new Document();
-
-const paragraph = new Paragraph("Hello World");
-doc.addParagraph(paragraph);
-
-doc.createImage(fs.readFileSync("./demo/images/image1.jpeg"));
-doc.createImage(fs.readFileSync("./demo/images/dog.png").toString("base64"));
-doc.createImage(fs.readFileSync("./demo/images/cat.jpg"));
-doc.createImage(fs.readFileSync("./demo/images/parrots.bmp"));
-doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
-    floating: {
-        horizontalPosition: {
-            offset: 1014400,
-        },
-        verticalPosition: {
-            offset: 1014400,
-        },
-    },
-});
-
-doc.createImage(fs.readFileSync("./demo/images/cat.jpg"), 200, 200, {
-    floating: {
-        horizontalPosition: {
-            relative: HorizontalPositionRelativeFrom.PAGE,
-            align: HorizontalPositionAlign.RIGHT,
-        },
-        verticalPosition: {
-            relative: VerticalPositionRelativeFrom.PAGE,
-            align: VerticalPositionAlign.BOTTOM,
-        },
-    },
-});
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo6.ts

@@ -1,29 +0,0 @@
-// 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, Packer, Paragraph, TextRun } from "../build";
-
-const doc = new Document(undefined, {
-    top: 0,
-    right: 0,
-    bottom: 0,
-    left: 0,
-});
-
-const paragraph = new Paragraph("Hello World");
-const institutionText = new TextRun("Foo bar").bold();
-const dateText = new TextRun("Github is the best").tab().bold();
-paragraph.addRun(institutionText);
-paragraph.addRun(dateText);
-
-doc.addParagraph(paragraph);
-
-doc.createParagraph("Hello World").heading1();
-doc.createParagraph("Foo bar");
-doc.createParagraph("Github is the best");
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo8.ts

@@ -1,17 +0,0 @@
-// Add text to header and footer
-// 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();
-
-doc.createParagraph("Hello World");
-
-doc.Header.createParagraph("Header text");
-doc.Footer.createParagraph("Footer text");
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/demo9.ts

@@ -1,17 +0,0 @@
-// Add images to header and footer
-// 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();
-
-doc.createParagraph("Hello World");
-
-doc.Header.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-doc.Footer.createImage(fs.readFileSync("./demo/images/pizza.gif"));
-
-const packer = new Packer();
-
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/index.ts

@@ -19,13 +19,16 @@ prompt.start();
 
 prompt.get(schema, (_, result) => {
     const demoNumber = result.number;
-    const filePath = `./demo/demo${demoNumber}.ts`;
+    const files = fs.readdirSync("./demo").filter((fn) => fn.startsWith(demoNumber));
 
-    if (!fs.existsSync(filePath)) {
-        console.error(`demo${demoNumber} does not exist: ${filePath}`);
+    if (files.length === 0) {
+        console.error(`demo number ${demoNumber} does not exist`);
         return;
     }
-    console.log(`Running demo ${demoNumber}`);
+
+    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 {

docs/README.md

@@ -1,13 +1,3 @@
-<p align="center">
-    <img alt="clippy the assistant" src="https://i.imgur.com/pwCV6L8.png">
-</p>
-
-<p align="center">
-    Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
-</p>
-
----
-
 # Welcome
 
 ## Installation
@@ -18,44 +8,54 @@ npm install --save docx
 
 Then you can `require` or `import` as usual:
 
-```js
-let docx = require("docx");
+```ts
+const docx = require("docx");
 ```
 
-```js
+```ts
 import * as docx from "docx";
+// or
+import { ... } from "docx";
 ```
 
 ## Basic Usage
 
-```js
-var fs = require("fs");
-var docx = require("docx");
+```ts
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "docx";
 
 // Create document
-var doc = new docx.Document();
+const doc = new Document();
 
-// 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);
+// 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
+doc.addSection({
+    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
-var packer = new docx.Packer();
-packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My First Document.docx", buffer);
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
 });
 
 // Done! A file called 'My First Document.docx' will be in your file system.
 ```
 
-## Honoured Mentions
-
-[@felipeochoa](https://github.com/felipeochoa)
-
-[@h4buli](https://github.com/h4buli)
-
 <p align="center">
     <img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
 </p>

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
+-   50+ usage examples
+-   Battle tested, mature, 95%+ coverage
+
+[GitHub](https://github.com/dolanmiu/docx)
+[Get Started](#Welcome)

docs/_sidebar.md

@@ -1,6 +1,6 @@
 * [Getting Started](/)
 
-* [Examples](examples.md)
+* [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
 
 * API
 
@@ -9,6 +9,7 @@
 * Usage
 
 	* [Document](usage/document.md)
+    * [Sections](usage/sections.md)
 	* [Paragraph](usage/paragraph.md)
 	* [Text](usage/text.md)
 	* [Image](usage/images.md)

docs/contribution-guidelines.md

@@ -1,25 +1,23 @@
 # Contribution Guidelines
 
-*   Include documentation reference(s) at the top of each file:
+-   Include documentation reference(s) at the top of each file:
 
-    ```js
+    ```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 Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
 
-*   Follow the `TSLint` rules
+-   Follow the `TSLint` rules
 
 ## Always think about the user
 
-The number one pillar for contribution to `docx` is to **ALWAYS** think about how the user will use `docx`.
-
 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 consistent with the rest of the API?
+4. Is it declarative?
 5. Is it fun to use?
 
 ## Good Commit Names
@@ -27,6 +25,7 @@ Put yourself in their position, and imagine how they would feel about your featu
 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
@@ -35,116 +34,62 @@ demo updated // Getting better, but capitalize the first letter
 Unesesary coment removed // Make sure to use correct spelling
 ```
 
-## No leaky components in API interface
-
-> This mainly applies to the API the end user will consume.
-
-Try to make method parameters of the outside API accept primitives, or `json` objects, so that child components are created **inside** the component, rather than being **injected** in.
-
-This is so that:
-
-1. Imports are much cleaner for the end user, no need for:
-   ```js
-   import { ChildComponent } from "./my-feature/sub-component/deeper/.../my-deep.component";
-   ```
-
-2. This is what I consider "leakage". The code is aware of the underlying implementation of the component.
-3. It means the end user does not need to import and create the child component to be injected.
-
-**Do not**
-
-`TableFloatProperties` is a class. The outside world would have to `new` up the object, and inject it in like so:
-
-```js
-    public float(tableFloatProperties: TableFloatProperties): Table
-```
-
-```ts
-    table.float(new TableFloatProperties(...));
-```
-
 **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:
 
-```js
+```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
-    table.float({...});
+const paragraph = doc.createParagraph();
+const text = paragraph.createText();
+text.contents = "Hello World";
 ```
 
-## Add vs Create
+**Do**
 
-This is just a guideline, and the rules can sometimes be broken.
-
-*   Use `create` if the method `new`'s up an element inside:
-
-    ```js
-    public createParagraph() {
-        const paragraph = new Paragraph();
-        this.root.push(paragraph);
-    }
-    ```
-
-*   Use `add` if you add the element into the method as a parameter.
-    *Note:* This may look like its breaking the previous guideline, but it has semantically different meanings. The previous one is using data to construct an object, whereas this one is simply adding elements into the document:
-
-    ```js
-    public addParagraph(paragraph: Paragraph) {
-        this.root.push(paragraph);
-    }
-    ```
+```ts
+doc.addSection({
+    children: [
+        new Paragraph({
+            children: [new TextRun("Hello World")],
+        }),
+    ],
+});
+```
 
 ## Getters and Setters
 
 Getters and Setters are done with a capital letter like so:
 
-```js
+```ts
 public get Level() {
    ...
 }
 ```
 
-There is no performance advantage by doing this. It means we don't need to prefix all private variables with the ugly `_`:
+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:**
 
-```js
+```ts
 private get _level: string;
 ```
 
 **Do**
 
-```js
+```ts
 private get level: string;
 ```
 
-## Temporal Methods
-
-Some methods  are `non-temporal`, which means regardless of when you call the method, it will have the same affect on the document. For example, setting the width of a table at the end of the document will have the same effect as setting the width at the start:
-
-```ts
-table.setWidth(1000); // now removed as of version 5.0.0
-```
-
-Whereas some methods are `temporal`, which means depending on the time-frame they are called, it would produce a difference result. For example, moving `createParagraph()` around your code will physically alter the document.
-
-```ts
-doc.createParagraph("hello");
-```
-
-If a method is `non-temporal`, put it in the objects `constructor`. For example:
-
-```ts
-const table = new Table(width: number);
-```
-
-`Non-temporal` methods are usually methods which can only be used one time and one time only. For example, `.float()`. It does not make sense to call `.float()` again if its already floating.
-
-I am not sure what the real term is, but this will do.
-
 ## Interfaces over type alias
 
 Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
@@ -152,19 +97,19 @@ Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a
 > "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
+> -   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:**
 
-```js
-type RelationshipFileInfo = { id: number, target: string };
+```ts
+type RelationshipFileInfo = { id: number; target: string };
 ```
 
 **Do:**
 
-```js
+```ts
 interface IRelationshipFileInfo {
     id: number;
     target: string;
@@ -177,13 +122,13 @@ To take full advantage of TypeScript's typing system, its best to use `string en
 
 **Do not:**
 
-```js
+```ts
 type WeaponType = "bow" | "sword" | "wand";
 ```
 
 **Do:**
 
-```js
+```ts
 enum WeaponType = {
     BOW = "bow",
     SWORD = "sword",
@@ -193,26 +138,26 @@ enum WeaponType = {
 
 ## Spell correctly, in full and in American English
 
-I am not sure where these habits in software development come from, but I do not believe it is beneficial:
-
 **Do not:**
-```js
-readdy // misspelling
-perm // abbreviation
-conf // abbreviation
-cnty // abbreviation
-relationFile // abbreviation
-colour // U.K. English
+
+```ts
+readdy; // misspelling
+perm; // abbreviation
+conf; // abbreviation
+cnty; // abbreviation
+relationFile; // abbreviation
+colour; // U.K. English
 ```
 
 **Do:**
-```js
-ready
-permission
-config
-country
-relationshipFile
-color
+
+```ts
+ready;
+permission;
+config;
+country;
+relationshipFile;
+color;
 ```
 
 ## Keep files small (within reason)
@@ -231,7 +176,7 @@ Please write a test of every file you make and suffix it with `.spec.ts`.
 
 Here is a template of a test:
 
-```js
+```ts
 import { assert } from "chai";
 
 describe("ClassName", () => {

docs/examples.md

@@ -1,219 +0,0 @@
-# Examples
-
-> All examples can run independently and can be found in the `/demo` folder of the project
-
-All the examples below can be ran locally, to do so, run the following command:
-
-```sh
-npm run demo
-```
-
-This command 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.
-
-## Simple
-
-A simple hello world of the `docx` library:
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo1.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo1.ts_
-
-## Styles
-
-### Styling with JS
-
-This example shows how to customise the look and feel of a document using JS configuration
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo2.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo2.ts_
-
-### Styling with XML
-
-This example shows how to customise the look and feel of a document using XML configuration
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo13.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo13.ts_
-
-## Numbering
-
-This example shows many levels of numbering
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo3.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo3.ts_
-
-## Table
-
-Example of simple table
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_
-
-### Styling table borders
-
-Styling the borders of a table
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_
-
-## Images
-
-### Add image to the document
-
-Importing Images from file system path
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_
-
-### Add images to header and footer
-
-Example showing how to add image to headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_
-
-### Scaling images
-
-Example showing how to scale images
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo12.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo12.ts_
-
-### Add Image to media before adding to document
-
-This is the best way to add an image to a document because you can add the same image in two locations without increasing document size by re-using the same image
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo23.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo23.ts_
-
-### Add image to table
-
-As before, to add an image to a table, you would need to add it to the `Media` object first
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_
-
-### Images using Base64 URI
-
-If you want to use a Base64 image instead
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo18.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo18.ts_
-
-## Margins
-
-Example showing how to set custom margins
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo6.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo6.ts_
-
-## Orientation
-
-Example showing how to set the document to `landscape` or `portrait`
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo7.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo7.ts_
-
-## Headers & Footers
-
-Example showing how to add headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo8.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo8.ts_
-
-## Multiple headers and footers
-
-Check out `Sections` for this feature
-
-## Page Breaks
-
-### Normal page breaks
-
-Example showing how to page break
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo14.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo14.ts_
-
-### Page break before
-
-Example showing how to page break before like in Word
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo15.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo15.ts_
-
-## Sections
-
-Example of how sections work. Sections allow multiple headers and footers, and `landscape`/`portrait` inside the same document. 
-Also you can have different page number formats and starts for different sections.
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo16.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo16.ts_
-
-## Footnotes
-
-Example of how to add footnotes. Good for references
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo17.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo17.ts_
-
-## Packers
-
-## Buffer output
-
-Example showing how to use the Buffer packer and then write that buffer to the file system
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo19.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo19.ts_
-
-
-## Bookmarks
-
-Example showing how to make bookmarks to make internal hyperlinks within the document
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo21.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo21.ts_
-
-## Bidirectional text
-
-Example showing how to use bidirectional text for certain languages such as Hebrew
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo22.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo22.ts_
-
-## Showcase
-
-### My CV
-
-Example showing how to add headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo10.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo10.ts_
-
-### Style and Images
-
-This example shows how to customise the look and feel of a document and add images
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo11.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo11.ts_

docs/index.html

@@ -1,31 +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>
 
-<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="//unpkg.com/docsify/lib/themes/vue.css">
-</head>
-
-<body>
-    <div id="app"></div>
-    <script>
-        window.$docsify = {
-            name: 'docx',
-            repo: 'https://github.com/dolanmiu/docx',
-            loadSidebar: true,
-            subMaxLevel: 2,
-            search: 'auto',
-        }
-    </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>
-</body>
-
+    <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

@@ -4,18 +4,17 @@
 
 To make a bullet point, simply make a paragraph into a bullet point:
 
-```js
-var text = new docx.TextRun("Bullet points");
-var paragraph = new docx.Paragraph(text).bullet();
-
-var text2 = new docx.TextRun("Are awesome");
-var paragraph2 = new docx.Paragraph(text2).bullet();
-
-doc.addParagraph(paragraph);
-doc.addParagraph(paragraph2);
+```ts
+const text = new TextRun("Bullet points");
+const paragraph = new Paragraph({
+    text: "Bullet points",
+    bullet: {
+        level: 0, // How deep you want the bullet to me
+    },
+});
 ```
 
 ### This will produce:
 
-*   Bullet points
-*   Are awesome
+-   Bullet points
+-   Are awesome