{"_id":"@btitterington_org/docx","_rev":"1-f704ffc6fc35dbc96375351d385a8d76","name":"@btitterington_org/docx","dist-tags":{"latest":"1.0.0"},"versions":{"8.5.1":{"name":"@btitterington_org/docx","version":"8.5.1","description":"Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.","type":"module","main":"build/index.umd.js","module":"./build/index.mjs","types":"./build/index.d.ts","exports":{".":{"require":"./build/index.cjs","types":"./build/index.d.ts","import":"./build/index.mjs","default":"./build/index.mjs"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build","test":"vitest --ui --coverage","test:ci":"vitest run --coverage","prepublishOnly":"npm run build --omit=dev","lint":"eslint --ext .ts src","predemo":"npm run build","demo":"tsx ./demo/index.ts","typedoc":"typedoc src/index.ts --tsconfig tsconfig.typedoc.json","prettier":"prettier -l \"{src,scripts,demo}/**/*.{ts,html}\"","prettier:fix":"npm run prettier -- --write","cspell":"cspell \"{src,demo,docs,scripts}/**/*.{ts,scss,html,md}\" && cspell \"./*.*\"","serve.docs":"cd docs && docsify serve","extract":"tsx scripts/extract-document.ts","run-ts":"tsx"},"pre-commit":["prettier","lint"],"repository":{"type":"git","url":"git+https://github.com/dolanmiu/docx.git"},"keywords":["docx","office","word","generate","creator","create","document","doc","officegen","clippy"],"dependencies":{"@types/node":"^20.3.1","jszip":"^3.10.1","nanoid":"^5.0.4","xml":"^1.0.1","xml-js":"^1.6.8"},"author":{"name":"Dolan Miu"},"license":"MIT","bugs":{"url":"https://github.com/dolanmiu/docx/issues"},"homepage":"https://docx.js.org","devDependencies":{"@types/inquirer":"^9.0.3","@types/prompt":"^1.1.1","@types/unzipper":"^0.10.4","@types/xml":"^1.0.8","@typescript-eslint/eslint-plugin":"^6.9.1","@typescript-eslint/parser":"^6.9.1","@vitest/coverage-v8":"^1.1.0","@vitest/ui":"^1.1.0","cspell":"^8.2.3","docsify-cli":"^4.3.0","eslint":"^8.23.0","eslint-plugin-functional":"^6.0.0","eslint-plugin-import":"^2.26.0","eslint-plugin-jsdoc":"^46.2.6","eslint-plugin-no-null":"^1.0.2","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-unicorn":"^50.0.1","execa":"^8.0.1","glob":"^10.2.7","inquirer":"^9.2.7","jsdom":"^23.0.1","pre-commit":"^1.2.2","prettier":"^3.1.1","tsconfig-paths":"^4.0.0","tsx":"^4.7.0","typedoc":"^0.25.4","typescript":"5.3.3","unzipper":"^0.10.11","vite":"^5.0.10","vite-plugin-dts":"^3.3.1","vite-plugin-node-polyfills":"^0.19.0","vite-tsconfig-paths":"^4.2.0","vitest":"^1.1.0"},"engines":{"node":">=10"},"gitHead":"fc87357f2757ca013ff1c28d140bbf3c37766e62","_id":"@btitterington_org/docx@8.5.1","_nodeVersion":"19.9.0","_npmVersion":"9.6.3","dist":{"integrity":"sha512-U2QCJGOM2Ohi5HbBwX0lDMUHDnwes0FenBuBfxmgqSbg1sz7OdeWug5Bea5SrN8iNp4uANdI4wpyUZf/T7lCDA==","shasum":"8060274553e594e929a7017152de5439ac976782","tarball":"https://registry.npmjs.org/@btitterington_org/docx/-/docx-8.5.1.tgz","fileCount":517,"unpackedSize":3056275,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCeb2weKdyW284UOLr7ioFsjdvmrF63DSlGb4BC6qSPMQIhAMG3w0nrIT/WCWVy16gK2eB8noT/tdE00N6pOi+B3gEM"}]},"_npmUser":{"name":"btitterington","email":"titteringtonb@gmail.com"},"directories":{},"maintainers":[{"name":"btitterington","email":"titteringtonb@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docx_8.5.1_1712158480841_0.989606095245469"},"_hasShrinkwrap":false},"1.0.0":{"name":"@btitterington_org/docx","version":"1.0.0","description":"Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.","type":"module","main":"build/index.umd.js","module":"./build/index.mjs","types":"./build/index.d.ts","exports":{".":{"require":"./build/index.cjs","types":"./build/index.d.ts","import":"./build/index.mjs","default":"./build/index.mjs"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build","test":"vitest --ui --coverage","test:ci":"vitest run --coverage","prepublishOnly":"npm run build --omit=dev","lint":"eslint --ext .ts src","predemo":"npm run build","demo":"tsx ./demo/index.ts","typedoc":"typedoc src/index.ts --tsconfig tsconfig.typedoc.json","prettier":"prettier -l \"{src,scripts,demo}/**/*.{ts,html}\"","prettier:fix":"npm run prettier -- --write","cspell":"cspell \"{src,demo,docs,scripts}/**/*.{ts,scss,html,md}\" && cspell \"./*.*\"","serve.docs":"cd docs && docsify serve","extract":"tsx scripts/extract-document.ts","run-ts":"tsx"},"pre-commit":["prettier","lint"],"repository":{"type":"git","url":"git+https://github.com/BTitterington/docx.git"},"keywords":["docx","office","word","generate","creator","create","document","doc","officegen","clippy"],"dependencies":{"@types/node":"^20.3.1","jszip":"^3.10.1","nanoid":"^5.0.4","xml":"^1.0.1","xml-js":"^1.6.8"},"author":{"name":"Dolan Miu"},"license":"MIT","bugs":{"url":"https://github.com/dolanmiu/docx/issues"},"homepage":"https://docx.js.org","devDependencies":{"@types/inquirer":"^9.0.3","@types/prompt":"^1.1.1","@types/unzipper":"^0.10.4","@types/xml":"^1.0.8","@typescript-eslint/eslint-plugin":"^6.9.1","@typescript-eslint/parser":"^6.9.1","@vitest/coverage-v8":"^1.1.0","@vitest/ui":"^1.1.0","cspell":"^8.2.3","docsify-cli":"^4.3.0","eslint":"^8.23.0","eslint-plugin-functional":"^6.0.0","eslint-plugin-import":"^2.26.0","eslint-plugin-jsdoc":"^46.2.6","eslint-plugin-no-null":"^1.0.2","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-unicorn":"^50.0.1","execa":"^8.0.1","glob":"^10.2.7","inquirer":"^9.2.7","jsdom":"^23.0.1","pre-commit":"^1.2.2","prettier":"^3.1.1","semantic-release":"^23.0.8","tsconfig-paths":"^4.0.0","tsx":"^4.7.0","typedoc":"^0.25.4","typescript":"5.3.3","unzipper":"^0.10.11","vite":"^5.0.10","vite-plugin-dts":"^3.3.1","vite-plugin-node-polyfills":"^0.19.0","vite-tsconfig-paths":"^4.2.0","vitest":"^1.1.0"},"engines":{"node":">=10"},"_id":"@btitterington_org/docx@1.0.0","gitHead":"59e42f63c89338abfa990d944ec6665d93a63c47","_nodeVersion":"20.12.2","_npmVersion":"10.7.0","dist":{"integrity":"sha512-5mwKroRnuLU6kQB12l44LgpAmx/7VAJ9LMN1m4CxsOEmr86Jngdo54MgueQbPXs10yTfAIWpNDfeIN2z3ue2fQ==","shasum":"77c3711967e8a3580a06876b8702fb14593688ee","tarball":"https://registry.npmjs.org/@btitterington_org/docx/-/docx-1.0.0.tgz","fileCount":517,"unpackedSize":3066247,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFr4IaSN8s2XDA1zI+lwH89eHhTIB7SvyNE1zt56KYetAiB3TtLbtPFr21Zr0/83W0/vUb9uqvuw7rbcbuOO5c+rGg=="}]},"_npmUser":{"name":"btitterington","email":"titteringtonb@gmail.com"},"directories":{},"maintainers":[{"name":"btitterington","email":"titteringtonb@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docx_1.0.0_1714677127327_0.20248777035625554"},"_hasShrinkwrap":false}},"time":{"created":"2024-04-03T15:34:40.746Z","8.5.1":"2024-04-03T15:34:41.152Z","modified":"2024-05-02T19:12:07.852Z","1.0.0":"2024-05-02T19:12:07.646Z"},"maintainers":[{"name":"btitterington","email":"titteringtonb@gmail.com"}],"description":"Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.","homepage":"https://docx.js.org","keywords":["docx","office","word","generate","creator","create","document","doc","officegen","clippy"],"repository":{"type":"git","url":"git+https://github.com/BTitterington/docx.git"},"author":{"name":"Dolan Miu"},"bugs":{"url":"https://github.com/dolanmiu/docx/issues"},"license":"MIT","readme":"<p align=\"center\">\n    <img src=\"./logo/logo-animate.svg\" width=\"100%\" height=\"300\" alt=\"clippy the assistant\">\n</p>\n\n<p align=\"center\">\n    Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.\n</p>\n\n---\n\n[![NPM version][npm-image]][npm-url]\n[![Downloads per month][downloads-image]][downloads-url]\n[![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]\n[![Known Vulnerabilities][snky-image]][snky-url]\n[![PRs Welcome][pr-image]][pr-url]\n[![codecov][codecov-image]][codecov-url]\n\n<p align=\"center\">\n    <img src=\"https://i.imgur.com/QeL1HuU.png\" alt=\"drawing\"/>\n</p>\n\n# Demo\n\n## Browser\n\nHere are examples of `docx` being used with basic `HTML/JS` in a browser environment:\n\n-   https://codepen.io/dolanmiu/pen/RwNeObg\n-   https://jsfiddle.net/dolanmiu/onadx1gu/\n\nHere are examples of `docx` working in `Angular`:\n\n-   https://stackblitz.com/edit/angular-docx\n-   https://stackblitz.com/edit/angular-wmd6k3\n\nHere are examples of `docx` working in `React`:\n\n-   https://stackblitz.com/edit/react-docx\n-   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)\n\nHere is an example of `docx` working in `Vue.js`:\n\n-   https://stackblitz.com/edit/vuejs-docx\n\n## Node\n\nPress `endpoint` on the `RunKit` website:\n\n![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)\n\n-   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text\n-   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text\n-   https://runkit.com/dolanmiu/docx-demo3 - Bullet points\n-   https://runkit.com/dolanmiu/docx-demo4 - Simple table\n-   https://runkit.com/dolanmiu/docx-demo5 - Images\n-   https://runkit.com/dolanmiu/docx-demo6 - Margins\n-   https://runkit.com/dolanmiu/docx-demo7 - Landscape\n-   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer\n-   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**\n\nMore [here](https://github.com/dolanmiu/docx/tree/master/demo)\n\n# How to use & Documentation\n\nPlease refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!\n\n# Examples\n\nCheck the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.\n\n# Contributing\n\nRead the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).\n\n# Used by\n\n[<img src=\"https://i.imgur.com/zy5qWmI.png\" alt=\"drawing\" height=\"50\"/>](https://hfour.com/)\n[<img src=\"https://i.imgur.com/OYP5tgS.png\" alt=\"drawing\" height=\"50\"/>](https://fuzzproductions.com/)\n[<img src=\"https://i.imgur.com/zUDMfZ3.png\" alt=\"drawing\" height=\"50\"/>](https://www.mettzer.com/)\n[<img src=\"https://i.imgur.com/wtNB1uq.png\" alt=\"drawing\" height=\"50\"/>](https://www.wisedoc.net/)\n[<img src=\"https://i.imgur.com/suiH2zc.png\" alt=\"drawing\" height=\"50\"/>](https://www.dabblewriter.com/)\n[<img src=\"https://i.imgur.com/1LjuK2M.png\" alt=\"drawing\" height=\"50\"/>](https://turbopatent.com/)\n[<img src=\"https://i.imgur.com/dHMg0wF.gif\" alt=\"drawing\" height=\"50\"/>](http://www.madisoncres.com/)\n[<img src=\"https://i.imgur.com/QEZXU5b.png\" alt=\"drawing\" height=\"50\"/>](https://www.beekast.com/)\n[<img src=\"https://i.imgur.com/XVU6aoi.png\" alt=\"drawing\" height=\"50\"/>](https://herraizsoto.com/)\n[<img src=\"https://i.imgur.com/fn1xccG.png\" alt=\"drawing\" height=\"50\"/>](http://www.ativer.com.br/)\n[<img src=\"https://i.imgur.com/cmykN7c.png\" alt=\"drawing\"/>](https://www.arity.co/)\n[<img src=\"https://i.imgur.com/PXo25um.png\" alt=\"drawing\" height=\"50\"/>](https://www.circadianrisk.com/)\n[<img src=\"https://i.imgur.com/AKGhtlh.png\" alt=\"drawing\"/>](https://lexense.com/)\n[<img src=\"https://i.imgur.com/9tqJaHw.png\" alt=\"drawing\" height=\"50\"/>](https://novelpad.co/)\n\n...and many more!\n\n---\n\n[![patreon][patreon-image]][patreon-url]\n[![browserstack][browserstack-image]][browserstack-url]\n\nMade with 💖\n\n[npm-image]: https://badge.fury.io/js/docx.svg\n[npm-url]: https://npmjs.org/package/docx\n[downloads-image]: https://img.shields.io/npm/dm/docx.svg\n[downloads-url]: https://npmjs.org/package/docx\n[github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg\n[github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions\n[snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg\n[snky-url]: https://snyk.io/test/github/dolanmiu/docx\n[pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[pr-url]: http://makeapullrequest.com\n[codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg\n[codecov-url]: https://codecov.io/gh/dolanmiu/docx\n[patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png\n[patreon-url]: https://www.patreon.com/dolanmiu\n[browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png\n[browserstack-url]: https://www.browserstack.com\n","readmeFilename":"README.md"}