Git Product home page Git Product logo

markdown-preview.vim's Introduction

markdown-preview.vim

Markdown Preview allows you to compile and preview markdown as generated HTML files. It has the ability to select and use customized stylesheets for previewing your own awesomeness. Previewing occurs within the default browser.

For more information on the plugin: :help markdown-preview within Vim or take a look at the help files on github.

Install

Download, fork, clone, or use it as a submodule within your ~/.vim/ directory.

Dependencies

Markdown Preview requires the following:

  • Vim version 7.0 or above with Ruby support

Either:

  • Redcarpet - The default parser to use if it's installed
  • Discount - The backup parser to use if redcarpet is not found

To get the Redcarpet parser:

gem install redcarpet

The easiest way to get Discount if your rocking homebrew is:

brew install discount

If not, see the installation instructions from David Parson's Discount repository

While not a requirement, default directories are tailored to work within a bundle directory as specified by the pathogen plugin.

Currently tested to work with MacVim and Vim from Terminal.

Credits

Inspired by:

Contributing

Contributions are welcome, simply fork do your magic and send me a pull request.

MIT License

Copyright (c) 2012 by Matthew Kitt

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

markdown-preview.vim's People

Contributors

mkitt avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.