JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17661
  • Score
    100M100P100Q140277F
  • License MIT

remark plugin to compile markdown to docx (Microsoft Word, Office Open XML).

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

npm npm check demo

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
  • 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-docx

Getting 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.

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()] });

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" })] });

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()] });

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()] });

Documentation

Contribute

All contributions are welcome. If you find a problem, feel free to create an issue or a PR.

Making a Pull Request

  1. Fork this repo.
  2. Run npm install.
  3. Commit your fix.
  4. Add tests to cover the fix.
  5. Make a PR and confirm all the CI checks passed.