word-to-markdown

(β˜… 1,550)

A ruby gem to liberate content from Microsoft Word documents

File Explorer

Download Latest Version (.zip)
  • .codeclimate.yml
  • .gitignore
  • .hadolint.yml
  • .rubocop.yml
  • .rubocop_todo.yml
  • .travis.yml
  • appveyor.yml
  • docker-compose.yml
  • Dockerfile
  • Gemfile
  • LICENSE.md
  • Rakefile
  • README.md
  • word-to-markdown.gemspec

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/benbalter/word-to-markdown

Downloads the entire project code from GitHub to your computer.

cd word-to-markdown

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Ruby Ruby is required to use gem.
gem install word-to-markdown

Installs the package published on RubyGems directly.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose build

Runs the command against the services defined in the compose file.

docker-compose run --rm app bundle exec w2m --help

Runs the command against the services defined in the compose file.

docker-compose run --rm app bundle exec w2m test/fixtures/em.docx

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

docker-compose run --rm app bundle exec w2m --help

Runs the command against the services defined in the compose file.

docker-compose run --rm app bundle exec w2m test/fixtures/em.docx

Runs the command against the services defined in the compose file.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

Today's picks

netdata β˜… 80,204

The fastest path to AI-powered full stack observability, even for lean teams.

Go
freeCodeCamp β˜… 454,112

freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming, and compu

TypeScript
ragflow β˜… 88,599

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fuses cu

Go
mermaid β˜… 89,792

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner

TypeScript
ComfyUI β˜… 127,939

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes inte

Python
project-based-learning β˜… 279,456

Curated list of project-based tutorials

Python
// repository documentation