A simple and easy-to-use command-line tool for converting Microsoft Word documents (.docx) to Markdown format with automatic image extraction and saving.
No installation required, run directly:
npx word2md <input> [options]
npm install -g word2md
npm install word2md
# Generate markdown file in the same directory as the source file
npx word2md document.docx
# Specify output directory
npx word2md document.docx -o ./output
# Convert all .docx files in directory to output subdirectory
npx word2md ./docs
# Specify output directory
npx word2md ./docs -o ./converted
word2md - Convert Word documents (.docx) to Markdown
Usage:
npx word2md <input> [options]
Arguments:
<input> Path to a .docx file or directory containing .docx files
Options:
-o, --output <dir> Output directory (default: same as input for files, ./output for directories)
-h, --help Show this help message
-v, --version Show version
Examples:
npx word2md document.docx # Convert single file
npx word2md ./docs # Convert all .docx files in directory
npx word2md document.docx -o ./markdown # Convert to specific output directory
npx word2md ./docs -o ./converted # Batch convert to specific directory
The converted file structure is as follows:
output/
├── document.md # Converted Markdown file
└── images/ # Extracted images directory
├── image-uuid1.png
├── image-uuid2.jpg
└── ...
images/image-uuid.ext$ npx word2md report.docx
✅ Converted: D:\docs\report.docx → D:\docs\report.md
$ npx word2md ./documents
Found 3 .docx file(s) to convert...
✅ Converted: report1.docx → report1.md
✅ Converted: report2.docx → report2.md
✅ Converted: manual.docx → manual.md
$ npx word2md report.docx -o ./markdown
✅ Converted: D:\docs\report.docx → D:\markdown\report.md
This tool is built with the following tech stack:
git clone https://github.com/okfred/word2md.git
cd word2md
npm install
npm run dev
npm run build
npm test
Issues and Pull Requests are welcome!
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)This project is licensed under the MIT License. See the LICENSE file for details.
A: Currently only supports .docx format. Legacy .doc format is not supported.
A: No. Images are saved at original quality without any compression or processing.
A: Currently, password-protected .docx files are not supported.
A: For particularly large files, consider increasing Node.js memory limit:
node --max-old-space-size=4096 $(which npx) word2md large-file.docx
If this tool helps you, please give it a ⭐️ for support!
FAQs
Convert .docx files to Markdown with image extraction.
The npm package word2md receives a total of 8 weekly downloads. As such, word2md popularity was classified as not popular.
We found that word2md demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.