2017-03-07 23:10:35 +00:00
|
|
|
<p align="center">
|
2021-12-02 14:24:19 -06:00
|
|
|
<img src="./logo/logo-animate.svg" width="100%" height="300" alt="clippy the assistant">
|
2017-03-07 23:10:35 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
2018-08-21 22:29:40 +01:00
|
|
|
Easily generate .docx files with JS/TS. Works for Node and on the Browser.
|
2017-03-07 23:10:35 +00:00
|
|
|
</p>
|
2017-03-10 11:27:48 +00:00
|
|
|
|
2018-02-13 02:08:28 +00:00
|
|
|
---
|
2017-03-07 23:10:35 +00:00
|
|
|
|
2018-01-23 01:36:27 +00:00
|
|
|
[![NPM version][npm-image]][npm-url]
|
2018-05-16 20:10:12 +01:00
|
|
|
[![Downloads per month][downloads-image]][downloads-url]
|
2020-11-05 02:44:05 +00:00
|
|
|
[![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
|
2018-01-23 01:36:27 +00:00
|
|
|
[![Known Vulnerabilities][snky-image]][snky-url]
|
|
|
|
|
[![Chat on Gitter][gitter-image]][gitter-url]
|
2018-04-21 00:04:14 +01:00
|
|
|
[![PRs Welcome][pr-image]][pr-url]
|
2018-10-26 20:22:33 +01:00
|
|
|
[![codecov][codecov-image]][codecov-url]
|
2017-03-07 23:12:08 +00:00
|
|
|
|
2018-08-09 03:13:16 +01:00
|
|
|
<p align="center">
|
2021-03-21 18:36:15 +00:00
|
|
|
<img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
|
2018-08-09 03:13:16 +01:00
|
|
|
</p>
|
2016-07-04 09:03:25 +01:00
|
|
|
|
2018-08-09 11:51:27 +01:00
|
|
|
# Demo
|
2018-02-13 02:08:28 +00:00
|
|
|
|
2018-09-10 22:44:44 +01:00
|
|
|
## Browser
|
|
|
|
|
|
2019-03-05 13:29:36 +00:00
|
|
|
Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
|
2018-09-10 22:44:44 +01:00
|
|
|
|
2022-07-06 14:05:37 +01:00
|
|
|
- https://codepen.io/dolanmiu/pen/RwNeObg
|
|
|
|
|
- https://jsfiddle.net/dolanmiu/onadx1gu/
|
2018-09-10 22:44:44 +01:00
|
|
|
|
2022-11-29 19:29:32 +00:00
|
|
|
Here are examples of `docx` working in `Angular`:
|
2018-10-21 05:14:14 +01:00
|
|
|
|
2022-07-06 14:05:37 +01:00
|
|
|
- https://stackblitz.com/edit/angular-docx
|
2022-11-29 19:29:32 +00:00
|
|
|
- https://stackblitz.com/edit/angular-wmd6k3
|
2018-10-21 05:14:14 +01:00
|
|
|
|
2022-11-29 19:29:32 +00:00
|
|
|
Here are examples of `docx` working in `React`:
|
2020-07-16 12:35:47 +01:00
|
|
|
|
2022-07-06 14:05:37 +01:00
|
|
|
- https://stackblitz.com/edit/react-docx
|
|
|
|
|
- https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
|
2020-07-16 12:35:47 +01:00
|
|
|
|
2020-07-16 14:15:47 +01:00
|
|
|
Here is an example of `docx` working in `Vue.js`:
|
2020-07-16 14:13:55 +01:00
|
|
|
|
2022-07-06 14:05:37 +01:00
|
|
|
- https://stackblitz.com/edit/vuejs-docx
|
2020-07-16 14:13:55 +01:00
|
|
|
|
2018-09-10 22:44:44 +01:00
|
|
|
## Node
|
|
|
|
|
|
2018-02-13 02:07:56 +00:00
|
|
|
Press `endpoint` on the `RunKit` website:
|
2017-03-12 21:37:36 +00:00
|
|
|
|
2018-04-10 21:42:21 +01:00
|
|
|
|
|
|
|
|
|
2022-07-06 14:05:37 +01:00
|
|
|
- https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo3 - Bullet points
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo4 - Simple table
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo5 - Images
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo6 - Margins
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo7 - Landscape
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
|
|
|
|
|
- https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
|
2018-02-13 02:07:56 +00:00
|
|
|
|
2020-07-27 09:56:30 +01:00
|
|
|
More [here](https://github.com/dolanmiu/docx/tree/master/demo)
|
2018-09-10 22:44:44 +01:00
|
|
|
|
2018-08-09 11:51:27 +01:00
|
|
|
# How to use & Documentation
|
2017-03-13 00:54:05 +00:00
|
|
|
|
2018-08-09 11:52:47 +01:00
|
|
|
Please 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!
|
2016-07-04 09:03:25 +01:00
|
|
|
|
2018-08-09 11:51:27 +01:00
|
|
|
# Examples
|
2018-02-13 02:08:28 +00:00
|
|
|
|
2020-08-19 10:54:27 -10:00
|
|
|
Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
|
2016-07-04 09:03:25 +01:00
|
|
|
|
2018-08-09 11:51:27 +01:00
|
|
|
# Contributing
|
2017-09-19 15:56:52 +01:00
|
|
|
|
2018-08-04 04:03:08 +01:00
|
|
|
Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).
|
2017-09-19 15:56:52 +01:00
|
|
|
|
2018-12-05 20:11:46 +00:00
|
|
|
# Used by
|
2023-02-15 18:36:28 -05:00
|
|
|
|
2019-08-08 01:55:48 +01:00
|
|
|
[<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/)
|
2019-11-23 01:21:25 +00:00
|
|
|
[<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
|
2021-03-07 20:53:25 +00:00
|
|
|
[<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
|
2020-01-15 22:33:04 +00:00
|
|
|
[<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
|
2021-11-26 15:48:29 +00:00
|
|
|
[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
|
2021-03-07 20:53:25 +00:00
|
|
|
[<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
|
2021-11-26 15:48:29 +00:00
|
|
|
[<img src="https://i.imgur.com/AKGhtlh.png" alt="drawing"/>](https://lexense.com/)
|
2023-02-15 18:34:40 -05:00
|
|
|
[<img src="https://i.imgur.com/9tqJaHw.png" alt="drawing" height="50"/>](https://novelpad.co/)
|
2020-01-15 22:33:04 +00:00
|
|
|
|
2019-08-08 01:56:31 +01:00
|
|
|
...and many more!
|
|
|
|
|
|
2018-02-13 02:08:28 +00:00
|
|
|
---
|
2017-03-10 11:27:48 +00:00
|
|
|
|
2019-01-16 13:26:26 +00:00
|
|
|
[![patreon][patreon-image]][patreon-url]
|
2019-03-12 20:26:39 +00:00
|
|
|
[![browserstack][browserstack-image]][browserstack-url]
|
2019-01-16 13:26:26 +00:00
|
|
|
|
2017-03-11 16:05:20 +00:00
|
|
|
Made with 💖
|
2017-03-10 11:27:48 +00:00
|
|
|
|
2016-07-19 19:02:44 +01:00
|
|
|
[npm-image]: https://badge.fury.io/js/docx.svg
|
|
|
|
|
[npm-url]: https://npmjs.org/package/docx
|
2018-05-16 20:10:12 +01:00
|
|
|
[downloads-image]: https://img.shields.io/npm/dm/docx.svg
|
|
|
|
|
[downloads-url]: https://npmjs.org/package/docx
|
2020-11-05 02:44:05 +00:00
|
|
|
[github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
|
|
|
|
|
[github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
|
2017-03-08 20:42:56 +00:00
|
|
|
[snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
|
2017-03-10 11:24:41 +00:00
|
|
|
[snky-url]: https://snyk.io/test/github/dolanmiu/docx
|
2017-03-13 12:30:22 +00:00
|
|
|
[gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg
|
|
|
|
|
[gitter-url]: https://gitter.im/docx-lib/Lobby
|
2018-04-21 00:04:14 +01:00
|
|
|
[pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
|
|
|
|
|
[pr-url]: http://makeapullrequest.com
|
2018-10-26 20:22:33 +01:00
|
|
|
[codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
|
|
|
|
|
[codecov-url]: https://codecov.io/gh/dolanmiu/docx
|
2019-01-16 13:26:26 +00:00
|
|
|
[patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png
|
|
|
|
|
[patreon-url]: https://www.patreon.com/dolanmiu
|
2019-03-12 20:26:39 +00:00
|
|
|
[browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
|
|
|
|
|
[browserstack-url]: https://www.browserstack.com
|
