<commit_before>## vim-markdown-preview

vim-markdown-preview (abbreviated to VMP) is a Vim plugin to preview markdown
documents.

## Options

VMP has a few global options which alter its behavior:

* g:VMPoutputformat  
  *Default*: "html".  
  *Example*:  
  `let g:VMPoutputformat = 'pdf'`  
  *Note*   : Only "html" is supported right now.  

* g:VMPoutputdirectory  
  *Default*: "/tmp"   
  *Example*:  
  `let g:VMPoutputdirectory = '.'`  

* g:VMPhtmlreader  
  *Default*: "open" (Mac), "start" (Windows), "xdg-open" (Unix)   
  *Example*:  
  `let g:VMPhtmlreader = 'firefox-bin'`  

* g:VMPstylesheet
  *Default*: "github.css"  
  *Example*:  
  `let g:VMPstylesheet "safari-reader.css"`  
  *Note*   : Only "github.css" and "safari-reader.css" are accepted values.  

None of these options were available before and haven't been released yet.  
Clone the repo to try them!

## Install

**Download**  

* Option 1  
  Cloning this repository is one option, and the master branch should always be 
  in a working state.
   
* Option 2  
  You can download versioned releases from the 
  [downloads](http://github.com/robgleeson/vim-markdown-preview/downloads) page.

**Automatic installation**  
vim-markdown-preview is bundled with an installer script which will install to 
$HOME/.vim/plugin/

    sh install.sh

## Usage

Send vim the command `:Mm` for a preview of your markdown document.  
Alternatively, bind `:Mm` to a key binding: 
`map <leader>p :Mm<CR>` 


## Dependencies

* vim
* Ruby support for vim.
* kramdown (bundled with this package)

## OSX

_vim-markdown-preview_ was written to run on OSX, and it will work w/o 
problems.  
I recommend the safari browser because it will not open new tabs needlessly 
if a document is already loaded in an existing tab/window.

## Linux/Others

_vim-markdown-preview_ is tied to the OSX command `open`.  
You will need to replace it with something else - firefox-bin, for example, 
for it to work on your operating system.

## Credit

* <NAME>  
  This is an enitrely rewritten version of the vim script originally written by
  <NAME> and found 
  [here](http://mathias-biilmann.net/2009/1/markdown-preview-in-vim).

* [moreweb](http://github.com/moreweb)  
  Contributor.  

* [maba](http://github.com/maba)  
  Contributor. 


## Bugs

No known bugs right now. 
[Found a bug?](http://github.com/robgleeson/vim-markdown-preview/issues).

## Contact

* IRC  
  irc.freenode.net/#flowof.info as 'robgleeson'

* Mail  
  rob [at] flowof.info
<commit_msg>Remove dated sections of the README.<commit_after>## vim-markdown-preview

vim-markdown-preview (abbreviated to VMP) is a Vim plugin to preview markdown
documents.

## Options

VMP has a few global options which alter its behavior:

* g:VMPoutputformat  
  *Default*: "html".  
  *Example*:  
  `let g:VMPoutputformat = 'pdf'`  
  *Note*   : Only "html" is supported right now.  

* g:VMPoutputdirectory  
  *Default*: "/tmp"   
  *Example*:  
  `let g:VMPoutputdirectory = '.'`  

* g:VMPhtmlreader  
  *Default*: "open" (Mac), "start" (Windows), "xdg-open" (Unix)   
  *Example*:  
  `let g:VMPhtmlreader = 'firefox-bin'`  

* g:VMPstylesheet
  *Default*: "github.css"  
  *Example*:  
  `let g:VMPstylesheet "safari-reader.css"`  
  *Note*   : Only "github.css" and "safari-reader.css" are accepted values.  

None of these options were available before and haven't been released yet.  
Clone the repo to try them!

## Install

**Download**  

* Option 1  
  Cloning this repository is one option, and the master branch should always be 
  in a working state.
   
* Option 2  
  You can download versioned releases from the 
  [downloads](http://github.com/robgleeson/vim-markdown-preview/downloads) page.

**Automatic installation**  
vim-markdown-preview is bundled with an installer script which will install to 
$HOME/.vim/plugin/

    sh install.sh

## Usage

Send vim the command `:Mm` for a preview of your markdown document.  
Alternatively, bind `:Mm` to a key binding: 
`map <leader>p :Mm<CR>` 


## Dependencies

* vim
* Ruby support for vim.
* kramdown (bundled with this package)

## Credit

* <NAME>  
  This is an enitrely rewritten version of the vim script originally written by
  <NAME> and found 
  [here](http://mathias-biilmann.net/2009/1/markdown-preview-in-vim).

* [moreweb](http://github.com/moreweb)  
  Contributor.  

* [maba](http://github.com/maba)  
  Contributor. 


## Bugs

Bugs are tracked through 
[The GitHub Issue Tracker](http://github.com/robgleeson/vim-markdown-preview/issues).


{'fraction_non_alphanumeric': 0.11478299184842476, 'fraction_numerical': 0.0030843798193434676, 'mean_word_length': 3.468503937007874, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3887639', 'n_tokens_mistral': 1614, 'n_tokens_neox': 1515, 'n_words': 488}