docx-markdown-utils

A Node.js library for converting between Microsoft Word (.docx) documents and GitHub Flavored Markdown (GFM). Provides two main classes:

• WordToMarkdownConverter: Converts Word documents to Markdown.
• MarkdownToWordConverter: Converts Markdown files to Word documents.

Note: This library is tested in Node.js environments only. Browser support is not currently provided, but adding it should not be difficult.

Installation

npm install docx-markdown-utils

Usage

Convert Word to Markdown

import { WordToMarkdownConverter } from 'docx-markdown-utils';

const converter = new WordToMarkdownConverter();
const markdown = await converter.convert('path/to/input.docx', {
  // Optional: conversion options
});
console.log(markdown);

Convert Markdown to Word

import { MarkdownToWordConverter } from 'docx-markdown-utils';

const converter = new MarkdownToWordConverter();
const docxBuffer: Buffer = await converter.convert('path/to/input.md', {
  // Optional: conversion options
});
converter.saveToFile(docxBuffer, 'path/to/output.docx');

API

WordToMarkdownConverter

• convert(inputPath: string, options?: ConvertOptions): Promise<string>

MarkdownToWordConverter

• convert(inputPath: string, outputPath: string, options?: MdToWordConvertOptions): Promise<void>
• saveToFile(buffer: Buffer, outputPath: string): Promise<void>

License

Apache 2.0