• Stars
    star
    196
  • Rank 198,553 (Top 4 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 9 years ago
  • Updated about 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Word Diff empowers you to be a Markdown person in a Microsoft Word world by automatically converting any Word document committed to a GitHub repo to Markdown

Word Diff

Word Diff empowers you to be a Markdown person in a Microsoft Word world by automatically converting any Word document committed to a GitHub repo to Markdown.

Build Status

How it works

Lets say you have a file called document.docx and you commit it to your GitHub repo.

Word Diff will automatically make a second commit, along side your commit to add a document.md file, with the contents of document.docx converted to markdown. It'll even note that you're the commit author and copy over your commit message.

If you make changes and commit a new version of document.docx, Word Diff will update the document.md file, and if you delete document.docx, document.md gets deleted as well.

Under the hood, it uses word-to-markdown.

When you'd use this

If you're collaborating on text with someone:

  1. Using Git's native diff functionality, you can quickly verified what's changed or compare changes over time
  2. You can collaborate in Markdown/GitHub while the world collaborates via email/Word

Setup

  1. Create a bot account, and create a new personal access token with public_repo scope
  2. Set the token as a GITHUB_TOKEN environmental variable.
  3. Add the Word Diff server as a web hook on the repository, receiving push events. You can leave all other settings about formats as they are. Choose a shared secret token as SECRET_TOKEN which you then have to set on your server/hosting as well. See how you set it on heroku below.
  4. for local use, you can also store those variables in .env which you then should add to your .gitignore

Running on Heroku

  1. If you are familiar with heroku, just do what you do. If not, follow the ruby guide for heroku until you are logged in https://devcenter.heroku.com/articles/getting-started-with-ruby
  2. Clone the worddiff repo to a local folder of your choosing. Create the .env file with the above mentioned GITHUB_TOKEN and SECRET_TOKEN.
  3. With heroku installed, do heroku create in the worddiff folder. This also adds a heroku remote to your local git repo.
  4. In order to get LibreOffice installed, you'll want to run heroku config:add BUILDPACK_URL=https://github.com/ddollar/heroku-buildpack-multi.git. This will instruct Heroku to read the .buildpacks file. Ideally do this before you push to heroku the first time.
  5. Then set the two environment variable for Heroku: heroku config:set GITHUB_TOKEN=yourTokenHere and heroku config:set SECRET_TOKEN=yoursecretchosentoken
  6. Finally do git push heroku master and the app should be deployed. The heroku repo should have been added before.
  7. When opening the website heroku tells you, there should be nothing there but no error either.

Troubleshooting

  1. Check logs.
  2. Check if webhook works at the repository.

Running locally

  1. bundle exec rackup
  2. Follow the ngrok documentation to forward requests to your computer if you don't want to set up a development server

More Repositories

1

word-to-markdown

A ruby gem to liberate content from Microsoft Word documents
Ruby
1,463
star
2

wordpress-to-jekyll-exporter

One-click WordPress plugin that converts all posts, pages, taxonomies, metadata, and settings to Markdown and YAML which can be dropped into Jekyll (or Hugo or any other Markdown and YAML based site engine).
PHP
1,023
star
3

jekyll-auth

A simple way to use GitHub OAuth to serve a protected Jekyll site to your GitHub organization
Ruby
841
star
4

jekyll-remote-theme

Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
Ruby
291
star
5

github-mention-highlighter

A Chrome extension that automatically highlights any time you are mentioned on a GitHub issue or pull request thread by highlighting your username, any team you're a member of, and the border of any containing comment.
TypeScript
273
star
6

gman

A ruby gem to check if the owner of a given email address or website is working for THE MAN (a.k.a verifies government domains).
Ruby
164
star
7

dc-maps

Maps of Washington DC area public geodata
Ruby
152
star
8

pi-hole-cloudflared-docker-compose-ansible-caddy

Example configuration for using Pi-Hole, Cloudflared, Docker Compose, Ansible, and Caddy to over-engineer your home network for privacy and security.
Dockerfile
150
star
9

congressional-districts

Historic and current US Congressional districts as GeoJSON, versioned within Git
149
star
10

benbalter.github.com

The personal website of Ben Balter. Built using Jekyll and GitHub Pages. See humans.txt for more infos.
Ruby
146
star
11

jekyll-relative-links

A Jekyll plugin to convert relative links to markdown files to their rendered equivalents
Ruby
140
star
12

jekyll-include-cache

A Jekyll plugin to cache the rendering of Liquid includes
Ruby
113
star
13

count-org-loc

Count total lines of code across a GitHub organization
Ruby
108
star
14

github_records_archiver

Backs up a GitHub organization's repositories and all their associated information for archival purposes.
Ruby
108
star
15

geojson-diff

A Ruby library for diffing GeoJSON files
Ruby
101
star
16

jekyll-titles-from-headings

Ruby
94
star
17

dc-wifi-social

A collaborative list of DC locations that serve up both Internet and Alcohol
Shell
90
star
18

jekyll-readme-index

A Jekyll plugin to render a project's README as the site's index.
Ruby
87
star
19

site-inspector

Ruby Gem to sniff information about a domain's technology and capabilities.
Ruby
84
star
20

markdown_to_word

Converts GitHub-flavored Markdown to a Word document
Ruby
83
star
21

jekyll-optional-front-matter

A Jekyll plugin to make front matter optional for Markdown files
Ruby
82
star
22

wordpress-plugin-tests

A Travis CI compatible unit testing for WordPress plugins that utilizes the WordPress core unit testing framework and PHPUnit
PHP
76
star
23

retlab

A minimalist Jekyll theme for your personal site
HTML
75
star
24

markdown-to-pdf

On demand generation of enterprise-grade PDFs from GitHub-hosted markdown files
Ruby
74
star
25

word-to-markdown-server

A hosted version of the Word to Markdown gem
Ruby
70
star
26

jekyll-style-guide

An opinionated guide to common Jekyll design patterns and anti-patterns.
Shell
66
star
27

github-forms

A RESTful API for submitting standard HTML form data to a GitHub-hosted CSV.
CSS
65
star
28

comment-card

A simple interface for non-technical users — both authenticated and pseudonymous — to provide feedback for your GitHub-hosted project
Ruby
56
star
29

jekyll-default-layout

Silently sets default layouts for Jekyll pages and posts
Ruby
55
star
30

jekyllbot

Listens for GitHub post-recieve service hooks messages, runs jekyll, and pushes the results back to GitHub.
Ruby
54
star
31

problem_child

Allows authenticated or anonymous users to fill out a standard web form to create GitHub issues (and pull requests).
Ruby
50
star
32

zoom-launcher

A command line tool for joining your next Zoom meeting.
Ruby
48
star
33

open-source-alternatives

A collaborative list of open-source alternatives to typical government and enterprise software needs
HTML
47
star
34

change_agent

A Git-backed key-value store, for tracking changes to documents and other files over time
Ruby
46
star
35

situation-clock

LED-style Situation Room wall clock formatted for iPads
TypeScript
37
star
36

github-uploader

A simple app to enable drag-and-drop uploading of binary and other assets to GitHub Repositories
Ruby
36
star
37

word-to-markdown-js

Convert Word documents to beautiful Markdown. Via command line or in your browser.
TypeScript
36
star
38

Convert-Word-Documents-to-HTML

Cleans up the otherwise-ugly output generated by Microsoft Word when you use the File -> Save As HTML option and optionally includes Twitter Bootstrap
PHP
35
star
39

troll-repellant

A micro-service to automatically comment on and close issues opened by bothersome users.
Ruby
35
star
40

zoom-go

A command line tool for joining your next Zoom meeting.
Go
34
star
41

huebot

Changes a Phillips Hue light's color and flashes based on GitHub's status
Ruby
34
star
42

dotfiles

@BenBalter's computering environment and the scripts to initialize it and keep it up to date.
Ruby
31
star
43

jekyll-bootstrap-sass

A plugin to add Twitter Bootstrap to your Jekyll site
Ruby
30
star
44

Frequency-Analysis

Script to parse text file and find frequency of n-word phrases
PHP
30
star
45

redliner

A tool for facilitating the redlining of documents with the GitHub uninitiated
Ruby
27
star
46

add-to-org

A simple Oauth App to automatically add users to an organization
Ruby
27
star
47

avatar-montage

Create a tiled montage (or collage) of GitHub Avatar images for use in all hands and other "welcome" or "thank you" slides
Shell
25
star
48

open-sourcing-government

Presentation on applying the open-collaboration philosophy to the process of governing
CSS
25
star
49

WP-Resume

Out-of-the-box solution to get your resume online. Built on WordPress's custom post types, it offers a uniquely familiar approach to publishing
PHP
25
star
50

sitemap-parser

Ruby Gem to parse sitemaps.org compliant sitemaps
Ruby
24
star
51

jekyll-restful-api-generator

Given a CSV file (or a series of YAML files), generates a RESTful API using Jekyll
PHP
21
star
52

plister

A utility for programmatically setting OS X plist file preferences
Ruby
21
star
53

Twitter-Mentions-as-Comments

Please note: This project is no longer actively maintained and is seeking a new maintainer.
PHP
20
star
54

naughty_or_nice

You've made the list, we'll help you check it twice. Given a domain-like string, verifies inclusion in a list you provide.
Ruby
19
star
55

bulk-issue-creator

Bulk opens batches of issues (or posts comments) across GitHub repositories based on a template and CSV of values. Think of it like "mail merge" for GitHub issues.
TypeScript
18
star
56

gmail-and-google-calendar-stats

Scrapes your GMail and Google Calendar data and returns it as a CSV for further analysis.
TypeScript
17
star
57

ra11y

Ruby-based automated accessibility testing
Ruby
16
star
58

pdftotext

A Ruby wrapper for the `pdftotext` command line library
Ruby
15
star
59

Site-Inspector-php

PHP Class to provide information about a given domain.
PHP
15
star
60

coconductor

A work-in-progress code of conduct detector based off Licensee
Ruby
15
star
61

government-glossary

A GovSpeak to English translator a.k.a. glossary of common government IT and procurement terms, abbreviations and acronyms (CGITPTAA)
Ruby
15
star
62

2016-campaign-tech

An entirely unofficial look at the technology stacks of the 2016 Presidential Campaigns
Ruby
14
star
63

squad_goals

A tiny app to allow open-source contributors to opt-in to GitHub teams.
Ruby
12
star
64

Plugin-Boilerplate

PHP
12
star
65

Infinite-Scroll

"Fork" of the infinite scroll WordPress Plugin
PHP
12
star
66

copy-issue-link-bookmarklet

Copies a markdown link to the GitHub issue you're currently viewing in the form of [issue title](issue URL).
TypeScript
12
star
67

2021-analysis-of-federal-dotgov-domains

Analysis of what technologies power federal .gov websites - 2021 edition.
HTML
12
star
68

open-source-for-government

A collaborative resource for government employees looking to participate in the open source community
HTML
12
star
69

simple-api

An example of making a simple API with Jekyll and GitHub Pages
12
star
70

open_source_stats

A quick script to generate metrics about the contribution your organization makes to the open source community in a 24-hour period
Ruby
11
star
71

issue-shadower

A webhook receiver to mirror GitHub.com issues to private GitHub Enterprise forks.
Ruby
10
star
72

so_far_so_good

A Ruby Gem to parse and manipulate the Federal Acquisition Regulation (FAR) and Defense Federal Acquisition Regulation Supplement (DFARS)
Ruby
9
star
73

copy-to

A quick-and-dirty Heroku app to simulate running `git clone`, `git remote add`, and `git push` locally.
Ruby
9
star
74

wordpress-unix-theme

Unix-like Interface for Wordpress
JavaScript
9
star
75

.github

Script to share community files (e.g., CONTRIBUTING.md) and probot configuration files across repositories
Ruby
8
star
76

Domain-Inventory

WordPress plugin to track Federal .Govs by Agency, Status, Non-WWW Support, IPv6 Support, CDN, CMS, Cloud Provider, Analytics, JavaScript Libraries, and HTTPs support.
PHP
7
star
77

tweets

Archive's historical Tweets as a Jekyll site on GitHub Pages
HTML
7
star
78

PCLJ-Members-Workspace

Customization of WP Document Revisions for the Public Contract Law Journal
PHP
7
star
79

wordpress-plugin-boilerplate-classes

PHP
7
star
80

Convert-Microsoft-Word-Footnotes-to-WordPress-Simple-Footnotes

Plugin to parse Microsoft Word footnotes into WordPress's Simple Footnotes format
PHP
7
star
81

behind-github-geojson

Open source, open standards and 50 lines of code: A look behind GitHub’s GeoJSON rendering and diffing
CSS
7
star
82

feedback

Ask @benbalter anything!
6
star
83

markdown-table-formatter

A Ruby class to normalize column lengths in a markdown table
Ruby
6
star
84

when-did-nacin-last-blog

Answering the internet's toughest questions since 2011.
Ruby
6
star
85

hubot-webscale

A web-sockets based Hubot adapter to allow Hubot to be embedded in a website at webscale.
CoffeeScript
6
star
86

meeting-matrix

Visually counts down the time remaining in a meeting on an RGB LED Matrix using a Raspberry Pi.
Python
6
star
87

ti-83-programs

The first (useful) software I ever wrote. Calculator programs written between 2001 and 2005 on a TI-83 Plus.
Shell
5
star
88

Recursive-Merge-Sort-in-PHP

Recursive Merge Sort Function in PHP
JavaScript
5
star
89

import_export

A Ruby client for Trade.gov's Consolidated Screening List
Ruby
5
star
90

Encrypt-Posts

WordPress Plugin that provides data-at-rest encryption of post content
PHP
5
star
91

bot-notification-silencer

Marks notifications from bots as read.
TypeScript
5
star
92

federal-open-source-repositories

A dynamically generated list of open source projects hosted on GitHub
Ruby
5
star
93

change_agent_demo

Demo data store for https://github.com/benbalter/change_agent
4
star
94

jekyll-accessibility-template

Jekyll Voluntary Product Accessibility Template (VPAT) and §508 accessibility information template
HTML
4
star
95

jekyll-edit-link

A Jekyll tag that generates links to edit the current page on GitHub
Ruby
4
star
96

make-maps-better-together

Collaborative mapping the GitHub Wayâ„¢
CSS
4
star
97

chilling_effects

A Ruby gem to interact with the Chilling Effects API
Ruby
4
star
98

dont-build-an-api

Presentation for the DC API meetup
CSS
4
star
99

go-huebot

Changes a Phillips Hue light's color and flashes based on GitHub's status
Go
4
star
100

site-inspector-demo

HTML
3
star