Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A markdown viewer that renders on the fly.
JavaScript Ruby
branch: master

README.md

Markview

Markview allows you to view nearly any and all markup formatted files in a slick way. Markview is inspired by the python library restview. Markview has the ability to render virtually any and all markup formatted files using the github-markup library.

Install

$ sudo gem install markview

Usage

Markview is very simple to use. Run the gem from the command line and specify a README or other markdown file. Markview defaults to finding a file with the base name README if you choose not to specify the file.

$ markview README.md

Preview

Markview Preview

Author

Mark Sands :: marksands07@gmail.com

License

Copyright (c) 2010, 2011 Mark Sands

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.