@sunertech/docx 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Dolan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,124 @@
1
+ <p align="center">
2
+ <img src="./logo/logo-animate.svg" width="100%" height="300" alt="clippy the assistant">
3
+ </p>
4
+
5
+ <p align="center">
6
+ Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.
7
+ </p>
8
+
9
+ ---
10
+
11
+ [![NPM version][npm-image]][npm-url]
12
+ [![Downloads per month][downloads-image]][downloads-url]
13
+ [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
14
+ [![Known Vulnerabilities][snky-image]][snky-url]
15
+ [![PRs Welcome][pr-image]][pr-url]
16
+ [![codecov][codecov-image]][codecov-url]
17
+ [![Docx.js Editor][docxjs-editor-image]][docxjs-editor-url]
18
+
19
+ <p align="center">
20
+ <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
21
+ </p>
22
+
23
+ # Demo
24
+
25
+ ## Browser
26
+
27
+ Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
28
+
29
+ - https://codepen.io/dolanmiu/pen/RwNeObg
30
+ - https://jsfiddle.net/dolanmiu/onadx1gu/
31
+
32
+ Here are examples of `docx` working in `Angular`:
33
+
34
+ - https://stackblitz.com/edit/angular-docx
35
+ - https://stackblitz.com/edit/angular-wmd6k3
36
+
37
+ Here are examples of `docx` working in `React`:
38
+
39
+ - https://stackblitz.com/edit/react-docx
40
+ - https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
41
+
42
+ Here is an example of `docx` working in `Vue.js`:
43
+
44
+ - https://stackblitz.com/edit/vuejs-docx
45
+
46
+ ## Node
47
+
48
+ Press `endpoint` on the `RunKit` website:
49
+
50
+ ![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
51
+
52
+ - https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
53
+ - https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
54
+ - https://runkit.com/dolanmiu/docx-demo3 - Bullet points
55
+ - https://runkit.com/dolanmiu/docx-demo4 - Simple table
56
+ - https://runkit.com/dolanmiu/docx-demo5 - Images
57
+ - https://runkit.com/dolanmiu/docx-demo6 - Margins
58
+ - https://runkit.com/dolanmiu/docx-demo7 - Landscape
59
+ - https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
60
+ - https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
61
+
62
+ More [here](https://github.com/sunertech/docx/tree/master/demo)
63
+
64
+ # How to use & Documentation
65
+
66
+ 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!
67
+
68
+ # Playground
69
+
70
+ Experience `docx` in action through [Docx.js Editor][docxjs-editor-url], an interactive playground where you can code and preview the results in real-time.
71
+
72
+ # Examples
73
+
74
+ Check the [demo folder](https://github.com/sunertech/docx/tree/master/demo) for examples.
75
+
76
+ # Contributing
77
+
78
+ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines).
79
+
80
+ # Used by
81
+
82
+ [<img src="https://i.imgur.com/zy5qWmI.png" alt="drawing" height="50"/>](https://hfour.com/)
83
+ [<img src="https://i.imgur.com/OYP5tgS.png" alt="drawing" height="50"/>](https://fuzzproductions.com/)
84
+ [<img src="https://i.imgur.com/zUDMfZ3.png" alt="drawing" height="50"/>](https://www.mettzer.com/)
85
+ [<img src="https://i.imgur.com/wtNB1uq.png" alt="drawing" height="50"/>](https://www.wisedoc.net/)
86
+ [<img src="https://i.imgur.com/suiH2zc.png" alt="drawing" height="50"/>](https://www.dabblewriter.com/)
87
+ [<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
88
+ [<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
89
+ [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
90
+ [<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
91
+ [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
92
+ [<img src="https://i.imgur.com/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
93
+ [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
94
+ [<img src="https://i.imgur.com/AKGhtlh.png" alt="drawing"/>](https://lexense.com/)
95
+ [<img src="https://i.imgur.com/9tqJaHw.png" alt="drawing" height="50"/>](https://novelpad.co/)
96
+ [<img src="https://i.imgur.com/5bLKFeP.png" alt="drawing" height="50"/>](https://proton.me/)
97
+
98
+ ...and many more!
99
+
100
+ ---
101
+
102
+ [![patreon][patreon-image]][patreon-url]
103
+ [![browserstack][browserstack-image]][browserstack-url]
104
+
105
+ Made with 💖
106
+
107
+ [npm-image]: https://badge.fury.io/js/docx.svg
108
+ [npm-url]: https://npmjs.org/package/docx
109
+ [downloads-image]: https://img.shields.io/npm/dm/docx.svg
110
+ [downloads-url]: https://npmjs.org/package/docx
111
+ [github-actions-workflow-image]: https://github.com/sunertech/docx/workflows/Default/badge.svg
112
+ [github-actions-workflow-url]: https://github.com/sunertech/docx/actions
113
+ [snky-image]: https://snyk.io/test/github/sunertech/docx/badge.svg
114
+ [snky-url]: https://snyk.io/test/github/sunertech/docx
115
+ [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
116
+ [pr-url]: http://makeapullrequest.com
117
+ [codecov-image]: https://codecov.io/gh/sunertech/docx/branch/master/graph/badge.svg
118
+ [codecov-url]: https://codecov.io/gh/sunertech/docx
119
+ [patreon-image]: https://user-images.githubusercontent.com/2917613/51251459-4e880480-1991-11e9-92bf-38b96675a9e2.png
120
+ [patreon-url]: https://www.patreon.com/dolanmiu
121
+ [browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
122
+ [browserstack-url]: https://www.browserstack.com
123
+ [docxjs-editor-image]: https://img.shields.io/badge/Docx.js%20Editor-2b579a.svg?style=flat&amp;logo=javascript&amp;logoColor=white
124
+ [docxjs-editor-url]: https://docxjs-editor.vercel.app/