From 08a3538d8ed7e310d4d418ebedcca080b678f96d Mon Sep 17 00:00:00 2001 From: Dolan Date: Sat, 4 Aug 2018 03:40:41 +0100 Subject: [PATCH] Update documentation --- docs/_sidebar.md | 4 ++-- docs/examples.md | 2 ++ docs/usage/packers.md | 6 ++++-- 3 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 docs/examples.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index f94c9751d3..6ce3f8fed6 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -2,7 +2,7 @@ * API - * [Documentation](/api) + * [Documentation](https://docx.js.org/api/) * Usage @@ -21,7 +21,7 @@ * [Packers](usage/packers.md) -* [Examples](usage/examples.md) +* [Examples](examples.md) * [Contribution Guidelines](contribution-guidelines.md) diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000000..65afe6047d --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,2 @@ +# Examples + diff --git a/docs/usage/packers.md b/docs/usage/packers.md index 2db1957b5e..1994781639 100644 --- a/docs/usage/packers.md +++ b/docs/usage/packers.md @@ -1,6 +1,6 @@ # 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 @@ -37,7 +37,9 @@ const buffer = exporter.pack(); ## 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 const docx = require("docx");