Skip to content

Converts GitHub-flavored Markdown to a Word document

License

Notifications You must be signed in to change notification settings

wiiikiii/markdown_to_word

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown to Word

Converts GitHub-flavored Markdown to a Word document

Build Status

Why

While Markdown is the lingua franca of the development world, the rest of the world still sees Word documents as the de facto way to share text. Rather than try to convert the rest of the world, just work in Markdown, and convert things to Word before sending to others.

Demo

You can see it in action with this demo

Installation

Add the following to your project's Gemfile:

gem 'markdown_to_word'

Usage

MarkdownToWord.convert("# Some Markdown").path
=> "/path/to/the/file.docx"

Command line usage

m2w "# Some Markdown" > foo.docx

(Returns the contents of the docx to STDOUT)

How it works

  1. We use HTML Pipeline to convert the Markdown to HTML
  2. We use HTML to Word to convert the HTML to a Word doc

Why not just use Pandoc?

While Pandoc is great on the desktop, it's hard to install on servers or use on Heroku.

Need to go the other way?

See Word to Markdown.

About

Converts GitHub-flavored Markdown to a Word document

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 90.9%
  • Shell 9.1%