Welcome

Installation

npm install --save docx

Then you can require or import as usual:

const docx = require("docx");

import * as docx from "docx";
// or
import { ... } from "docx";

Basic Usage

import * as fs from "fs";
import { Document, Packer, Paragraph, TextRun } from "docx";

// Create document
const doc = new Document();

// 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: "Github is the best",
                    bold: true,
                }).tab(),
            ],
        }),
    ],
});

// Used to export the file into a .docx file
const packer = new Packer();

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

@h4buli

Made with 💖