remark-docx 0.2.0 → 0.3.0

package/README.md

@@ -2,7 +2,11 @@
 
 ![npm](https://img.shields.io/npm/v/remark-docx) ![npm](https://img.shields.io/npm/dw/remark-docx) ![check](https://github.com/inokawa/remark-docx/workflows/check/badge.svg) ![demo](https://github.com/inokawa/remark-docx/workflows/demo/badge.svg)
 
-[remark](https://github.com/remarkjs/remark) plugin to compile markdown to docx (Microsoft Word, Office Open XML).
+> [remark](https://github.com/remarkjs/remark) plugin to compile markdown to docx (Microsoft Word, Office Open XML).
+
+- Uses [docx](https://github.com/dolanmiu/docx) for compilation.
+- Works in any environment (e.g. browser, Node.js).
+- You can customize [mdast](https://github.com/syntax-tree/mdast) to Word transformation with plugin system.
 
 ### 🚧 WIP 🚧
 
@@ -19,25 +23,21 @@ If you have some feature requests or improvements, please create a [issue](https
 - [x] table
 - [x] tableRow
 - [x] tableCell
-- [ ] html
-- [ ] code
-- [ ] yaml
-- [ ] toml
 - [x] definition
 - [x] footnoteDefinition
 - [x] text
 - [x] emphasis
 - [x] strong
 - [x] delete
-- [ ] inlineCode
 - [x] break
-- [x] link
-- [x] image
-- [x] linkReference
-- [x] imageReference
-- [x] footnote
-- [x] footnoteReference
-- [x] LaTeX support with math and inlineMath ([remark-math](https://github.com/remarkjs/remark-math) is required)
+- [x] link / linkReference
+- [x] image / imageReference ([remark-docx/plugins/image](#image) is required)
+- [x] footnote / footnoteReference
+- [ ] html
+- [ ] yaml
+- [ ] toml
+- [ ] code / inlineCode
+- [x] math / inlineMath ([remark-math](https://github.com/remarkjs/remark-math) and [remark-docx/plugins/math](#latex) are required)
 
 ## Demo
 
@@ -49,7 +49,7 @@ https://inokawa.github.io/remark-docx/
 npm install remark-docx
 ```
 
-## Usage
+## Getting started
 
 ### Browser
 
@@ -59,14 +59,14 @@ import markdown from "remark-parse";
 import docx from "remark-docx";
 import { saveAs } from "file-saver";
 
-const processor = unified().use(markdown).use(docx, { output: "blob" });
+const processor = unified().use(markdown).use(docx);
 
 const text = "# hello world";
 
 (async () => {
   const doc = await processor.process(text);
-  const blob = await doc.result;
-  saveAs(blob, "example.docx");
+  const arrayBuffer = await doc.result;
+  saveAs(new Blob([arrayBuffer]), "example.docx");
 })();
 ```
 
@@ -78,17 +78,60 @@ import markdown from "remark-parse";
 import docx from "remark-docx";
 import * as fs from "fs";
 
-const processor = unified().use(markdown).use(docx, { output: "buffer" });
+const processor = unified().use(markdown).use(docx);
 
 const text = "# hello world";
 
 (async () => {
   const doc = await processor.process(text);
-  const buffer = await doc.result;
-  fs.writeFileSync("example.docx", buffer);
+  const arrayBuffer = await doc.result;
+  fs.writeFileSync("example.docx", Buffer.from(arrayBuffer));
 })();
 ```
 
+## With plugins
+
+### Image
+
+#### Browser
+
+```javascript
+import { unified } from "unified";
+import markdown from "remark-parse";
+import docx from "remark-docx";
+import { browserImagePlugin } from "remark-docx/plugins/image";
+
+const processor = unified()
+  .use(markdown)
+  .use(docx, { plugins: [browserImagePlugin()] });
+```
+
+#### Node.js
+
+```javascript
+import { unified } from "unified";
+import markdown from "remark-parse";
+import docx from "remark-docx";
+import { nodeImagePlugin } from "remark-docx/plugins/image";
+
+const processor = unified()
+  .use(markdown)
+  .use(docx, { plugins: [nodeImagePlugin()] });
+```
+
+### LaTeX
+
+```javascript
+import { unified } from "unified";
+import markdown from "remark-parse";
+import docx from "remark-docx";
+import { latexPlugin } from "remark-docx/plugins/math";
+
+const processor = unified()
+  .use(markdown)
+  .use(docx, { plugins: [latexPlugin()] });
+```
+
 ## Documentation
 
 - [API reference](./docs/API.md)