Skip to content

About

A simple CLI doc and docx to markdown translator

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc2markdown

Convert Microsoft Word (.docx) files to Markdown format with a simple CLI.

Installation

pip install doc2markdown

Or install from source:

git clone https://github.com/yourusername/doc2markdown.git
cd doc2markdown
pip install .

Usage

# Convert a file (output uses same name with .md extension)
doc2markdown document.docx

# Specify output file
doc2markdown document.docx output.md

# Overwrite existing output file
doc2markdown document.docx -w

Both doc2markdown and docx2markdown commands are available:

docx2markdown document.docx

Features

  • Headings — Converts H1–H6 styles to # headers
  • Inline formatting — Bold (**), italic (*), and code (`) preserved
  • Lists — Bullet and numbered lists converted
  • Tables — Markdown table syntax with header row and separators
  • Block quotes — Styled as > blockquotes

Requirements

  • Python 3.10+
  • click ≥ 8.0
  • python-docx ≥ 1.0

License

MIT License - feel free to modify and extend!

About

A simple CLI doc and docx to markdown translator

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages