Package Exports
- remark-docx
- remark-docx/package.json
- remark-docx/plugins/image
- remark-docx/plugins/math
Readme
remark-docx
remark plugin to compile markdown to docx (Microsoft Word, Office Open XML).
- Uses docx for compilation.
- Works in any environment (e.g. browser, Node.js).
- You can customize mdast to Word transformation with plugin system.
🚧 WIP 🚧
This project is aiming to support all nodes in mdast syntax tree, but currently transformation and stylings may not be well.
If you have some feature requests or improvements, please create a issue or PR.
- paragraph
- heading
- thematicBreak
- blockquote
- list
- listItem
- table
- tableRow
- tableCell
- definition
- footnoteDefinition
- text
- emphasis
- strong
- delete
- break
- link / linkReference
- image / imageReference (remark-docx/plugins/image is required)
- footnote / footnoteReference
- html
- yaml
- toml
- code / inlineCode
- math / inlineMath (remark-math and remark-docx/plugins/math are required)
Demo
https://inokawa.github.io/remark-docx/
Install
npm install remark-docxGetting started
Browser
import { unified } from "unified";
import markdown from "remark-parse";
import docx from "remark-docx";
import { saveAs } from "file-saver";
const processor = unified().use(markdown).use(docx);
const text = "# hello world";
(async () => {
const doc = await processor.process(text);
const arrayBuffer = await doc.result;
saveAs(new Blob([arrayBuffer]), "example.docx");
})();Node.js
import { unified } from "unified";
import markdown from "remark-parse";
import docx from "remark-docx";
import * as fs from "fs";
const processor = unified().use(markdown).use(docx);
const text = "# hello world";
(async () => {
const doc = await processor.process(text);
const arrayBuffer = await doc.result;
fs.writeFileSync("example.docx", Buffer.from(arrayBuffer));
})();With plugins
Image
Browser
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
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
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
Contribute
All contributions are welcome. If you find a problem, feel free to create an issue or a PR.
Making a Pull Request
- Fork this repo.
- Run
npm install. - Commit your fix.
- Add tests to cover the fix.
- Make a PR and confirm all the CI checks passed.