Merge pull request #186 from instant-markdown/minimal-vimrc

Minimal vimrc for issues

.github/ISSUE_TEMPLATE.md

@@ -9,34 +9,30 @@
  * Vim / Neovim version:
  * Browser:
 
-## Provide the debug output (required)
+## Steps to reproduce the issue (required)
 
-Run `cat my_markdown_file.md | instant-markdown-d --mathjax --debug` and paste the
-console output here:
+Start with command you used to install `instant-markdown-d`. Use [a
+minimal.vimrc](https://raw.githubusercontent.com/instant-markdown/vim-instant-markdown/master/doc/minimal.vimrc)
+to reproduce the issue and open your markdown file as:
 
 ```sh
-
+vim -u minimal.vimrc my_markdown_file.md
 ```
 
-## Generate log files (required)
+ 1.
+ 2.
+ 3.
 
-```
-let g:instant_markdown_logfile = '/tmp/instant_markdown.log'
-```
 
- 1. Add the above in your `~/.vimrc` or `~/.config/nvim/init.vim`. Modify the
-    path if needed and generate the log file.
- 1. Minimal `~/.vimrc` or `~/.config/nvim/init.vim` where variables for
-    `vim-instant-markdown` defined
- 1. `debug.html`
+## Provide the debug output (required)
 
-## Steps to reproduce the issue (required)
+Run `cat my_markdown_file.md | instant-markdown-d --mathjax --debug`. It
+generates a `debug.html` file - attach it here. Also, paste the console output
+here:
 
-Start with command you used to install `instant-markdown-d`
+```sh
 
- 1.
- 2.
- 3.
+```
 
 
 ## Screen shot (if possible)

AUTHORS.md

@@ -0,0 +1,25 @@
+# Authors
+
+- Suan-Aik Yeo (creator)
+- Ashwin Vishnu (maintainer)
+
+# Thanks
+
+To all contributors:
+
+- Bryan Richter
+- Andy Russell
+- Anthony Panozzo
+- Dominick Pham
+- Fabio Pelosin
+- Ingo Karkat
+- James Hogan
+- Johann Philipp Strathausen
+- MortalHappiness
+- Phan Hai Phong
+- QMonkey
+- Ricardo Santos
+- Rob Wu
+- Sebastian Kosch
+- Terry Ma
+- xieshiyao

README.md

@@ -33,13 +33,13 @@ Installation
   - [vim-plug][plug]
 
     ```vim
-    Plug 'suan/vim-instant-markdown', {'for': 'markdown'}
+    Plug 'instant-markdown/vim-instant-markdown', {'for': 'markdown'}
     ```
 
   - [Vundle][vundle]
 
     ```vim
-    Plugin 'suan/vim-instant-markdown', {'rtp': 'after'}
+    Plugin 'instant-markdown/vim-instant-markdown', {'rtp': 'after'}
     ```
 
 - Minimal default configuration:
@@ -182,14 +182,14 @@ FAQ
 > It's not working!
 
 - Make sure `instant-markdown-d` was installed as a global module (e.g. using `npm -g install`)
-- If you're on OSX and are using zsh, try to add `set shell=bash\ -i` in your `.vimrc` to set interactive bash as the default vim shell. (See [this issue](http://github.com/suan/vim-instant-markdown/issues/41))
+- If you're on OSX and are using zsh, try to add `set shell=bash\ -i` in your `.vimrc` to set interactive bash as the default vim shell. (See [this issue](http://github.com/instant-markdown/vim-instant-markdown/issues/41))
 
 > Why don't my `<bla>.md` files trigger this plugin?
 
 By default, vim versions before 7.4.480 only recognize files ending with `.markdown`, `.mdown`, and `README.md` as markdown files. If you want `<anything>.md` to be recognized, I recommend installing one of many markdown plugins available, such as [this one][tpope-markdown].
 
 _If you're curious, the code for the mini-server component for this plugin can
-be found at http://github.com/suan/instant-markdown-d. A plugin can easily be
+be found at http://github.com/instant-markdown/instant-markdown-d. A plugin can easily be
 written for any editor to interface with the server to get the same
 functionality found here._
 

doc/minimal.vimrc

@@ -0,0 +1,25 @@
+set nocompatible
+filetype off
+
+call plug#begin('~/.vim/plugged')
+Plug 'junegunn/vim-plug'
+Plug 'instant-markdown/vim-instant-markdown', {'for': ['markdown', 'markdown.pandoc']}
+call plug#end()
+
+filetype plugin indent on
+syntax enable
+set nomore
+set noswapfile
+set viminfo=
+
+let g:instant_markdown_logfile = '/tmp/instant_markdown.log'
+"Uncomment to override defaults:
+"let g:instant_markdown_slow = 1
+"let g:instant_markdown_autostart = 0
+"let g:instant_markdown_open_to_the_world = 1
+"let g:instant_markdown_allow_unsafe_content = 1
+"let g:instant_markdown_allow_external_content = 0
+"let g:instant_markdown_mathjax = 1
+"let g:instant_markdown_autoscroll = 0
+"let g:instant_markdown_port = 8888
+"let g:instant_markdown_python = 1

doc/vim-instant-markdown.txt

@@ -59,11 +59,11 @@ Quick start (assuming you have all the necessary dependencies):
     choice:
     *   vim-plug (https://github.com/junegunn/vim-plug)
 >
-            Plug 'suan/vim-instant-markdown', {'for': 'markdown'}
+            Plug 'instant-markdown/vim-instant-markdown', {'for': 'markdown'}
 <
     *   Vundle (https://github.com/gmarik/Vundle.vim)
 >
-            Plugin 'suan/vim-instant-markdown', {'rtp': 'after'}
+            Plugin 'instant-markdown/vim-instant-markdown', {'rtp': 'after'}
 <
 *   Minimal default configuration:
 >
@@ -230,7 +230,7 @@ OSX, Unix/Linuxes*, and Windows**.
 *   Make sure `instant-markdown-d` was installed as a global module (e.g. using )
 *   If you're on OSX and are using zsh, try to add  in your `.vimrc` to set
     interactive bash as the default vim shell. (See this issue
-    (http://github.com/suan/vim-instant-markdown/issues/41))
+    (http://github.com/instant-markdown/vim-instant-markdown/issues/41))
 >
     Why don't my `<bla>.md` files trigger this plugin?
 <
@@ -241,7 +241,7 @@ By default, vim versions before 7.4.480 only recognize files ending with
 plugins available, such as this one (https://github.com/tpope/vim-markdown).
 
 If you're curious, the code for the mini-server component for this plugin can
-be found at http://github.com/suan/instant-markdown-d. A plugin can easily be
+be found at http://github.com/instant-markdown/instant-markdown-d. A plugin can easily be
 written for any editor to interface with the server to get the same
 functionality found here.