Package Exports
- remark-docx
- remark-docx/package.json
- remark-docx/plugins/html
- remark-docx/plugins/image
- remark-docx/plugins/latex
- remark-docx/plugins/shiki
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.
Supported mdast nodes
Currently, some of the default styles may not be nice. If you have feature requests or improvements, please create a issue or PR.
- paragraph
- heading
- thematicBreak (rendered as Page Break/Section Break)
- blockquote
- list / listItem
- table / tableRow / tableCell
- definition
- text
- emphasis
- strong
- delete
- inlineCode
- break
- link / linkReference
- footnote / footnoteReference / footnoteDefinition
- image / imageReference (plugin)
- html (plugin)
- code (plugin)
- math / inlineMath (remark-math and plugin)
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
Fetch image data and embed into docx. png, jpg, gif, bmp, svg urls are supported.
import { unified } from "unified";
import markdown from "remark-parse";
import docx from "remark-docx";
import { imagePlugin } from "remark-docx/plugins/image";
const processor = unified()
.use(markdown)
.use(docx, { plugins: [imagePlugin()] });When we embed svg to docx, it also requires png image for compatibility reason. On browser, this plugin generate it automatically. On other enviroment like Node.js, please implement fallbackSvg prop.
import sharp from "sharp";
imagePlugin({
fallbackSvg: async ({ buffer }) => {
const png = await sharp(buffer).png().toBuffer();
return png.buffer;
},
});Code
Syntax highlighting with shiki.
import { unified } from "unified";
import markdown from "remark-parse";
import docx from "remark-docx";
import { shikiPlugin } from "remark-docx/plugins/shiki";
const processor = unified()
.use(markdown)
.use(docx, { plugins: [shikiPlugin({ theme: "dark-plus" })] });Math
Render LaTeX with MathJax.
import { unified } from "unified";
import markdown from "remark-parse";
import math from "remark-math";
import docx from "remark-docx";
import { latexPlugin } from "remark-docx/plugins/latex";
const processor = unified()
.use(markdown)
.use(math)
.use(docx, { plugins: [latexPlugin()] });HTML
Transform HTML to markdown.
import { unified } from "unified";
import markdown from "remark-parse";
import docx from "remark-docx";
import { htmlPlugin } from "remark-docx/plugins/html";
const processor = unified()
.use(markdown)
.use(docx, { plugins: [htmlPlugin()] });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.