Update documentation

This commit is contained in:
Dolan
2018-08-04 03:40:41 +01:00
parent 6b38a3637f
commit 08a3538d8e
3 changed files with 8 additions and 4 deletions

View File

@ -2,7 +2,7 @@
* API * API
* [Documentation](/api) * [Documentation](https://docx.js.org/api/)
* Usage * Usage
@ -21,7 +21,7 @@
* [Packers](usage/packers.md) * [Packers](usage/packers.md)
* [Examples](usage/examples.md) * [Examples](examples.md)
* [Contribution Guidelines](contribution-guidelines.md) * [Contribution Guidelines](contribution-guidelines.md)

2
docs/examples.md Normal file
View File

@ -0,0 +1,2 @@
# Examples

View File

@ -1,6 +1,6 @@
# Packers # Packers
I used the express exporter in my [website](http://www.dolan.bio). It's very useful, and is the preferred way if you want to make a downloadable file for a visitor. it is much better than generating a physical file on the server, and then passing a download link to that file. > Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`.
## File System Packer ## File System Packer
@ -37,7 +37,9 @@ const buffer = exporter.pack();
## Express Packer ## Express Packer
Simply use the exporter, and pass in the necessary parameters: I used the express exporter in my [website](http://www.dolan.bio).
Pass in the necessary parameters:
```js ```js
const docx = require("docx"); const docx = require("docx");