Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benbalter/word-to-markdown
A ruby gem to liberate content from Microsoft Word documents
https://github.com/benbalter/word-to-markdown
converter libreoffice markdown microsoft-word ruby word
Last synced: about 5 hours ago
JSON representation
A ruby gem to liberate content from Microsoft Word documents
- Host: GitHub
- URL: https://github.com/benbalter/word-to-markdown
- Owner: benbalter
- License: mit
- Created: 2014-03-22T20:03:23.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:16:17.000Z (7 months ago)
- Last Synced: 2024-12-05T02:04:44.211Z (7 days ago)
- Topics: converter, libreoffice, markdown, microsoft-word, ruby, word
- Language: Ruby
- Homepage: https://word2md.com
- Size: 1.21 MB
- Stars: 1,474
- Watchers: 46
- Forks: 156
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-ruby - word-to-markdown - Gem to convert Microsoft Word documents to Markdown. (Markdown Processors)
- keep-it-txt - word-to-markdown
- awesome-robotic-tooling - Word-to-Markdown - A ruby gem to liberate content from Microsoft Word document. (Documentation and Presentation)
- awesome-robotic-tooling - Word-to-Markdown - A ruby gem to liberate content from Microsoft Word document (Documentation and Presentation)
- awesome-robotic-tooling - Word-to-Markdown - A ruby gem to liberate content from Microsoft Word document. (Documentation and Presentation)
README
# Word to Markdown converter
A Ruby gem to liberate content from [the jail that is Word documents](http://ben.balter.com/2012/10/19/we-ve-been-trained-to-make-paper/#jailbreaking-content)
[](https://github.com/benbalter/word-to-markdown/actions/workflows/ci.yml) [](http://badge.fury.io/rb/word-to-markdown) [](http://inch-ci.org/github/benbalter/word-to-markdown) [](https://ci.appveyor.com/project/benbalter/word-to-markdown/branch/master) [](https://codeclimate.com/github/benbalter/word-to-markdown/maintainability) [](https://codeclimate.com/github/benbalter/word-to-markdown/test_coverage)
## The problem
> Our default content publishing workflow is terribly broken. [We've all been trained to make paper](http://ben.balter.com/2012/10/19/we-ve-been-trained-to-make-paper/), yet today, content authored once is more commonly consumed in multiple formats, and rarely, if ever, does it embody physical form. Put another way, our go-to content authoring workflow remains relatively unchanged since it was conceived in the early 80s.
>
> I'm asked regularly by government employees — knowledge workers who fire up a desktop word processor as the first step to any project — for an automated pipeline to convert Microsoft Word documents to [Markdown](http://guides.github.com/overviews/mastering-markdown/), the *lingua franca* of the internet, but as my recent foray into building [just such a converter](http://word-to-markdown.herokuapp.com/) proves, it's not that simple.
>
> Markdown isn't just an alternative format. Markdown forces you to write for the web.
**[Read more](http://ben.balter.com/2014/03/31/word-versus-markdown-more-than-mere-semantics/)**
## Just want to convert a Microsoft Word (or Google) document to Markdown?
You can use this **[hosted service](https://word2md.com/)** (or check out [its source](https://github.com/benbalter/word-to-markdown-server)).
## Install
You'll need to install [LibreOffice](http://www.libreoffice.org/). Then:
```bash
gem install word-to-markdown
```
## Usage
```ruby
file = WordToMarkdown.new("/path/to/document.docx")
=>
file.to_s
=> "# Test\n\n This is a test"
file.document.tree
=>
```
### Command line usage
Once you've installed the gem, it's just:
```
$ w2m path/to/document.docx
```
*Outputs the resulting markdown to stdout*
## Supports
* Paragraphs
* Numbered lists
* Unnumbered lists
* Nested lists
* Italic
* Bold
* Explicit headings (e.g., selected as "Heading 1" or "Heading 2")
* Implicit headings (e.g., text with a larger font size relative to paragraph text)
* Images
* Tables
* Hyperlinks
## Requirements and configuration
Word-to-markdown requires `soffice` a command line interface to LibreOffice that works on Linux, Mac, and Windows. To install soffice, see [the LibreOffice documentation](https://www.libreoffice.org/get-help/install-howto/).
## Testing
```
script/cibuild
```
## Docker
First, create the `Gemfile.lock` by installing the dependencies:
```
bundle install
```
Everything you need to run the executable locally:
```
docker-compose build
docker-compose run --rm app bundle exec w2m --help
docker-compose run --rm app bundle exec w2m test/fixtures/em.docx
```
## Hosted service
[Word-to-markdown-server](https://github.com/benbalter/word-to-markdown-server) contains a lightweight server for converting Word Documents as a service. A live version runs at [word2md.com](https://word2md.com).