![\"clippy](\"http://i60.tinypic.com/339pvtt.png\")
\n\n \n
\n Generate .docx files with JS/TS very easily, written in TS.\n
\n\n---\n\n[![NPM version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Dependency Status][gemnasium-image]][gemnasium-url]\n[![Known Vulnerabilities][snky-image]][snky-url]\n[![Chat on Gitter][gitter-image]][gitter-url]\n[![code style: prettier][prettier-image]][prettier-url]\n\n[](https://nodei.co/npm/docx/)\n\n# docx\n\n## Install\n\n```sh\n$ npm install --save docx\n```\n\n## Demo\n\nPress `endpoint` on the `RunKit` website:\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-demo6 - Margins\n* https://runkit.com/dolanmiu/docx-demo7 - Landscape\n* https://runkit.com/dolanmiu/docx-demo8/1.0.1 - Header and Footer\n* https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**\n\n#### Run demos locally:\n\n```sh\n$ npm run demo\n```\n\nThis 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.\n\n## Guide\n\nPlease refer to [the Wiki](https://github.com/dolanmiu/docx/wiki) for details on how to use this library, examples and much more!\n\nFull documentation can be found here: [http://dolanmiu.github.io/docx/index.html](http://dolanmiu.github.io/docx/index.html)\n\n## Simple Usage\n\n```js\n// Used to create docx files\nvar docx = require(\"docx\");\n\n// Create document\nvar doc = new docx.Document();\n\n// Add some content in the document\nvar paragraph = new docx.Paragraph(\"Some cool text here.\");\n// Add more text into the paragraph if you wish\nparagraph.addRun(new docx.TextRun(\"Lorem Ipsum Foo Bar\"));\ndoc.addParagraph(paragraph);\n\n// Used to export the file into a .docx file\nvar exporter = new docx.LocalPacker(doc);\n\n// Or use the express packer to make the file downloadable.\n// res is express' Response object\nvar exporter = new docx.ExpressPacker(doc, res);\n\nexporter.pack(\"My First Document\");\n// If you want to export it as a .pdf file instead\nexporter.packPdf(\"My First Document\");\n\n// done! A file called 'My First Document.docx'\n// will be in your file system if you used LocalPacker\n// Or it will start downloading if you are using Express\n```\n\n## Examples\n\nCheck [the Wiki](https://github.com/dolanmiu/docx/wiki/Examples) for examples.\n\n# Contributing\n\nRead the contribution guidelines [here](https://github.com/dolanmiu/docx/wiki/Contributing-Guidelines).\n\n---\n\nMade with 💖\n\nHuge thanks to [@felipeochoa](https://github.com/felipeochoa) for awesome contributions to this project\n\n[npm-image]: https://badge.fury.io/js/docx.svg\n[npm-url]: https://npmjs.org/package/docx\n[travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master\n[travis-url]: https://travis-ci.org/dolanmiu/docx\n[daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/dolanmiu/docx\n[snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg\n[snky-url]: https://snyk.io/test/github/dolanmiu/docx\n[gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg\n[gitter-url]: https://gitter.im/docx-lib/Lobby\n[gemnasium-image]: https://gemnasium.com/badges/github.com/dolanmiu/docx.svg\n[gemnasium-url]: https://gemnasium.com/github.com/dolanmiu/docx\n[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg\n[prettier-url]: https://github.com/prettier/prettier\n","readmeFilename":"README.md"}