https://github.com/doesdev/docxmarks

Super simple bookmark replacement / mail merge for docx files
https://github.com/doesdev/docxmarks

Last synced: about 20 hours ago
JSON representation

Super simple bookmark replacement / mail merge for docx files

• Host: GitHub
• URL: https://github.com/doesdev/docxmarks
• Owner: doesdev
• License: mit
• Created: 2015-09-13T20:22:08.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T17:54:48.000Z (7 months ago)
• Last Synced: 2024-05-06T12:22:19.433Z (7 months ago)
• Language: JavaScript
• Size: 185 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docxmarks   [![npm version](https://badge.fury.io/js/docxmarks.svg)](http://badge.fury.io/js/docxmarks)   [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)   [![Dependency Status](https://dependencyci.com/github/doesdev/docxmarks/badge)](https://dependencyci.com/github/doesdev/docxmarks)

Replace text in native bookmarks in Open XML Document Files (.docx).

Formatting will follow the initial style inside the bookmark. That is to say,

if you have content inside the bookmark the first character defines the styling.

This is the same behavior supplied in Microsoft Word's libraries.

This library exclusively manages text and includes optional functionality for adjusting the font size of bookmarks.

I say all of that to say if you need more advanced formatting and content

options then you should be using

[docxtemplater](https://github.com/open-xml-templating/docxtemplater).

## Install

`npm i docxmarks --save`

## Usage

```javascript

const docxmarks = require('docxmarks')

const fs = require('fs')

const docx = fs.readFileSync('path/to/document.docx')

const replacements = {

  first: 'Andrew',

  last: (val) => val || 'Carpenter',

  maybeNoBookmark: {append: true, setter: 'There is one now'}

}

// 11 is the font size for bookamrks which is opitional

const font = 11;

docxmarks(docx, replacements, font).then((data) => {

  fs.writeFileSync('path/to/newDocument.docx', data)

})

```

## API

#### Takes docx data, replaces bookmarks, returns `Promise` resolving with new docx data in the same encoding as provided in input.

** omitting `replacements` will resolve with an object describing bookmarks currently in the document*

#### `docxmarks(*docxData, *replacements)`

- **docxData** *[base64 | Buffer | ArrayBuffer | Uint8Array - required]*

- **replacements** *[object - optional]*

  - **key** - Name of bookmark to replace, is case sensitive

  - **value** *[string | function | object]* - Bookmark replacement value

    - **string** - Replace bookmark with string's value

    - **function** - Receives current text of bookmark, bookmark set with return value

    - **object** - {`*setter`, `*append`}

      - **setter** *[string | function - required]* same as string / function above

      - **append** *[boolean - optional - false]* if bookmark not found append to document

## Upgrading

Version 2.0.0 is a complete re-write with 100% different API. Use new API if

upgrading from an old version, as there is no transitional API.

## License

MIT © [Andrew Carpenter](https://github.com/doesdev)