Permalink
Browse files

Version 6.0

This is an upgrade for Gist.vim: changed to use github APIs. Note to remove cookies directory if you used.
  • Loading branch information...
1 parent 349948d commit 516bd65f923f6921b0aeb0ce7227fb90e74776df @mattn mattn committed with Mar 31, 2012
Showing with 533 additions and 529 deletions.
  1. +220 −0 README.mkd
  2. +274 −514 autoload/gist.vim
  3. +38 −14 doc/gist-vim.txt
  4. +1 −1 plugin/gist.vim
View
@@ -0,0 +1,220 @@
+### Gist.vim
+
+This is a vimscript for creating gists (http://gist.github.com).
+
+For the latest version please see https://github.com/mattn/gist-vim.
+
+## Usage:
+
+- Post current buffer to gist, using default privacy option.
+
+ :Gist
+
+- Post selected text to gist, using default privacy option.
+ This applies to all permutations listed below (except multi).
+
+ :'<,'>Gist
+
+- Create a private gist.
+
+ :Gist -p
+
+- Create a public gist.
+ (Only relevant if you've set gists to be private by default.)
+
+ :Gist -P
+
+> This is only relevant if you've set gists to be private by default;
+> if you get an empty gist list, try ":Gist --abandon".
+
+- Create a gist anonymously.
+
+ :Gist -a
+
+- Create a gist with all open buffers.
+
+ :Gist -m
+
+- Edit the gist (you need to have opened the gist buffer first).
+ You can update the gist with the ":w" command within the gist buffer.
+
+ :Gist -e
+
+- Edit the gist with name 'foo.js' (you need to have opened the gist buffer
+ first).
+
+ :Gist -e foo.js
+
+- Post/Edit with the description " (you need to have opened the gist buffer
+ first). >
+
+ :Gist -s something
+ :Gist -e -s something
+
+- Delete the gist (you need to have opened the gist buffer first).
+ Password authentication is needed.
+
+ :Gist -d
+
+- Fork the gist (you need to have opened the gist buffer first).
+ Password authentication is needed.
+
+ :Gist -f
+
+- Star the gist (you need to have opened the gist buffer first).
+ Password authentication is needed.
+
+ :Gist +1
+
+- Unstar the gist (you need to have opened the gist buffer first).
+ Password authentication is needed.
+
+ :Gist -1
+
+- Get gist XXXXX.
+
+ :Gist XXXXX
+
+- Get gist XXXXX and add to clipboard.
+
+ :Gist -c XXXXX
+
+- List your public gists.
+
+ :Gist -l
+
+- List gists from user "mattn".
+
+ :Gist -l mattn
+
+- List everyone's gists.
+
+ :Gist -la
+
+- List gists from your starred gists.
+
+ :Gist -ls
+
+## Tips:
+
+If you set g:gist_clip_command, gist.vim will copy the gist code with option
+'-c'.
+
+- Mac:
+
+ let g:gist_clip_command = 'pbcopy'
+
+- Linux:
+
+ let g:gist_clip_command = 'xclip -selection clipboard'
+
+- Others (cygwin?):
+
+ let g:gist_clip_command = 'putclip'
+
+If you want to detect filetype from the filename:
+
+ let g:gist_detect_filetype = 1
+
+If you want to open browser after the post:
+
+ let g:gist_open_browser_after_post = 1
+
+If you want to change the browser:
+
+ let g:gist_browser_command = 'w3m %URL%'
+
+or:
+
+ let g:gist_browser_command = 'opera %URL% &'
+
+On windows, this should work with your user settings.
+
+If you want to show your private gists with ":Gist -l":
+
+ let g:gist_show_privates = 1
+
+If you want your gist to be private by default:
+
+ let g:gist_private = 1
+
+If you get problems when creating gists try:
+
+ :Gist --abandon
+
+You need to either set global git config
+
+ $ git config --global github.user Username
+
+## Requirements:
+
+- curl command (http://curl.haxx.se/)
+- webapi-vim (https://github.com/mattn/webapi-vim)
+- and if you want to use your git profile, the git command-line client.
+
+## License:
+
+ Copyright 2010 by Yasuhiro Matsumoto
+ modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+## Install:
+
+Copy it to your plugin directory.
+gist.vim will create a curl cookie-jar file in your runtimepath.
+
+- rtp:
+ - plugin/gist.vim
+ - cookies/github
+
+If you want to uninstall gist.vim, remember to also remove `~/.gist-vim`.
+
+## Setup:
+
+This plugin uses github API v3. Setting value is stored in `~/.gist.vim`.
+gist-vim have two ways to access APIs.
+
+### Basic Auth
+
+Require github user ID and password. This is easy but not secure.
+
+### OAuth2
+
+1. Register your application.
+
+Note that you must set `Callback URL` as same as following.
+
+https://github.com/settings/applications/new
+
+fill like following
+
+![](http://mattn.github.com/gist-vim/static/image/setting1.png)
+
+2. Start `:Gist -l`
+
+You'll see some prompts. fill ClientID/CilentSecret. Then you can see browser show up.
+
+![](http://mattn.github.com/gist-vim/static/image/setting2.png)
+
+This is a PIN code.
+
+Copy this value and paste to prompt `PIN:`.
Oops, something went wrong.

0 comments on commit 516bd65

Please sign in to comment.