Viewmd

Viewmd is a command line tool for viewing your Markdown files (e.g. README.md) in your local browser. Uses GitHub dialect of Markdown and some elements of GitHub CSS for syntax highlighting, so the result should resemble what you'd see on Github once you commit the file.

I guess, we all hate committing files with bugs. In case of Markdown files, like README.md, it's possible to make some little mistake while editing the file (e.g. forget the trailing triple-backticks) and end up with an incorrectly formatted file checked in to your repository. Seeing it only on GitHub already, for example, and having to do another little fix & commit just to fix this little formatting mistake seens like an untidy process to me. Thus I created this really simple command-line tool to see how the file would look like before committing.

It's really simple and doesn't try to catch all errors (e.g. trying to open a non-existent file).

Please note that I tested it on MacOS only. If you use other OS in your development environment, it may not work. It actually uses Launchy for opening files, so it will all depend on Launchy's support for your OS.

This gem has many GitHub-specific dependencies (primarily, due to the use of html-pipeline). So, gem version conflicts are quite likely if you try to install this tool using Gemfile.

Install the gem yourself environment-wide as:

$ gem install viewmd

$ viewmd <filename>

Semantic versioning (http://semver.org/spec/v2.0.0.html) is used.

For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:

1. MAJOR version is incremented when incompatible API changes are made,
2. MINOR version is incremented when functionality is added in a backwards-compatible manner,
3. PATCH version is incremented when backwards-compatible bug fixes are made.

Major version "zero" (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable.

• html-pipeline
• github-markdown
• github-linguist
• pygments.rb
• rinku
• sanitize
• launchy
• CSS from pygments-github-style

1. Fork it ( https://github.com/moonfly/viewmd/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request