Skip to content

notthebestdev/markdown-to-docx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-to-docx

This program allows you to transform Markdown into a Word document.

Description

This project converts Markdown files into Microsoft Word (.docx) documents.

It preserves common block and inline-level elements (headings, lists, links, images, code blocks, emphasis, tables) and provides a small CLI to control input, output and templates.

Features

  • Fast: Processes large Markdown files quickly and efficiently.
  • Accurate: Preserves formatting for headings, lists, links, images, code blocks, emphasis, and tables.
  • CLI Tool: Simple command-line interface for easy integration into workflows.
  • Cross-platform: Works on Windows, macOS, and Linux.

Getting Started

To begin, install all dependencies in the project:

npm install

Then, build the CLI by running:

npm run build

Next, link the CLI globally:

npm link

Once linked, you can execute the CLI from your terminal:

md-to-docx

You can also run this locally without linking the CLI globally.

npm run dev

Usage (CLI)

When you run the program you will be prompted to provide:

  • Input file: path to the Markdown file to convert (required).

License

This project is licensed under the MIT License. See the LICENSE file for more info.

About

📖 Transform Markdown into a Word document.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •