295 lines
8.2 KiB
Plaintext
295 lines
8.2 KiB
Plaintext
|
*Gist.vim* Vimscript for creating gists (http://gist.github.com)
|
||
|
|
|
||
|
|
Usage |gist-vim-usage|
|
||
|
|
Tips |gist-vim-tips|
|
||
|
|
License |gist-vim-license|
|
||
|
|
Install |gist-vim-install|
|
||
|
|
Requirements |gist-vim-requirements|
|
||
|
|
Setup |gist-vim-setup|
|
||
|
|
FAQ |gist-vim-faq|
|
||
|
|
|
||
|
|
This is a vimscript for creating gists (http://gist.github.com)
|
||
|
|
|
||
|
|
For the latest version please see https://github.com/mattn/gist-vim.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
USAGE *:Gist* *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
|
||
|
|
<
|
||
|
|
- Post whole text to gist as public.
|
||
|
|
This is only relevant if you've set gists to be private by default.
|
||
|
|
>
|
||
|
|
:Gist -P
|
||
|
|
<
|
||
|
|
- 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 *gist-vim-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 the 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_post_private = 1
|
||
|
|
|
||
|
|
<
|
||
|
|
If you want to edit all files for gists containing more than one: >
|
||
|
|
|
||
|
|
let g:gist_get_multiplefile = 1
|
||
|
|
<
|
||
|
|
|
||
|
|
If you want to use on GitHub Enterprise: >
|
||
|
|
|
||
|
|
let g:gist_api_url = 'http://your-github-enterprise-domain/api/v3'
|
||
|
|
<
|
||
|
|
|
||
|
|
If you want to update a gist, embed >
|
||
|
|
|
||
|
|
GistID: xxxxx
|
||
|
|
>
|
||
|
|
in your local file, then call >
|
||
|
|
|
||
|
|
:Gist
|
||
|
|
>
|
||
|
|
|
||
|
|
If you want to update a gist when only |:w!|: >
|
||
|
|
|
||
|
|
" :w and :w! update a gist.
|
||
|
|
let g:gist_update_on_write = 1
|
||
|
|
|
||
|
|
" Only :w! updates a gist.
|
||
|
|
let g:gist_update_on_write = 2
|
||
|
|
>
|
||
|
|
All other values are treated as 1.
|
||
|
|
This variable's value is 1 by default.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
LICENSE *gist-vim-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 *gist-vim-install*
|
||
|
|
|
||
|
|
Copy following files into your plugin directory.
|
||
|
|
|
||
|
|
rtp:
|
||
|
|
- autoload/gist.vim
|
||
|
|
- plugin/gist.vim
|
||
|
|
|
||
|
|
If you want to uninstall gist.vim, remember to also remove `~/.gist-vim`.
|
||
|
|
|
||
|
|
You need to install webapi-vim also:
|
||
|
|
|
||
|
|
http://www.vim.org/scripts/script.php?script_id=4019
|
||
|
|
|
||
|
|
If you want to use latest one:
|
||
|
|
|
||
|
|
https://github.com/mattn/webapi-vim
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
REQUIREMENTS *gist-vim-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.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
SETUP *gist-vim-setup*
|
||
|
|
|
||
|
|
This plugin uses GitHub API v3. Setting value is stored in `~/.gist-vim`.
|
||
|
|
gist-vim have two ways to access APIs.
|
||
|
|
|
||
|
|
First, you need to set your GitHub username in global git config:
|
||
|
|
>
|
||
|
|
$ git config --global github.user Username
|
||
|
|
<
|
||
|
|
Then, gist.vim will ask for your password to create an authorization when you
|
||
|
|
first use it. The password is not stored and only the OAuth access token will
|
||
|
|
be kept for later use. You can revoke the token at any time from the list of
|
||
|
|
"Authorized applications" on GitHub's "Account Settings" page.
|
||
|
|
(https://github.com/settings/applications)
|
||
|
|
|
||
|
|
If you have two-factor authentication enabled on GitHub, you'll see the message
|
||
|
|
"Must specify two-factor authentication OTP code." In this case, you need to
|
||
|
|
create a "Personal Access Token" on GitHub's "Account Settings" page
|
||
|
|
(https://github.com/settings/applications) and place it in a file
|
||
|
|
named ~/.gist-vim like this:
|
||
|
|
>
|
||
|
|
token xxxxx
|
||
|
|
<
|
||
|
|
If you happen to have your password already written in ~/.gitconfig like
|
||
|
|
below:
|
||
|
|
>
|
||
|
|
[github]
|
||
|
|
password = xxxxx
|
||
|
|
<
|
||
|
|
Then, add following into your ~/.vimrc
|
||
|
|
>
|
||
|
|
let g:gist_use_password_in_gitconfig = 1
|
||
|
|
<
|
||
|
|
This is not secure at all, so strongly discouraged.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
FAQ *gist-vim-faq*
|
||
|
|
|
||
|
|
Q. :Gist give Forbidden error
|
||
|
|
A. Try to delete ~/.gist-vim. And authenticate again.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
THANKS *gist-vim-thanks*
|
||
|
|
|
||
|
|
AD7six
|
||
|
|
Bruno Bigras
|
||
|
|
c9s
|
||
|
|
Daniel Bretoi
|
||
|
|
Jeremy Michael Cantrell
|
||
|
|
Kien N
|
||
|
|
kongo2002
|
||
|
|
MATSUU Takuto
|
||
|
|
Matthew Weier O'Phinney
|
||
|
|
ornicar
|
||
|
|
Roland Schilter
|
||
|
|
steve
|
||
|
|
tyru
|
||
|
|
Will Gray
|
||
|
|
netj
|
||
|
|
|
||
|
|
vim:tw=78:ts=8:ft=help:norl:
|