Skip to content
vscode extension for quick gists
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode feat(settings): adds profileOptions to override profile values Feb 3, 2019
__mocks__ fix: public and private gist labels match reality Feb 3, 2019
bin chore: adds yarn bump Jun 10, 2018
images feat: adds configuration options Dec 29, 2018
src Merge pull request #99 from kenhowardpdx/bugfix/90-insights-messsage Feb 3, 2019
.gitattributes
.gitignore feat: adds profiles Nov 23, 2018
.prettierrc.json
.travis.yml style: fix linting Dec 29, 2018
.vscodeignore
BACKERS.md
CHANGELOG.md
CONTRIBUTING.md chore(CONTRIBUTING): Adds CONTRIBUTING.md Mar 3, 2017
LICENSE chore: clean up docs Aug 16, 2017
README.md feat(settings): adds profileOptions to override profile values Feb 3, 2019
icon.png
jest.config.js
package-lock.json
package.json
tsconfig.json ci: avoid conflicts with test runner and debugger Nov 21, 2018
tsconfig.prod.json ci: avoid conflicts with test runner and debugger Nov 21, 2018
tslint.json

README.md

Gist Extension

Marketplace Version Build Status

Installs Coverage Status

Access your GitHub Gists within Visual Studio Code. You can add, edit, and delete public and private gists.

Installation

Press F1 and narrow down the list commands by typing extension. Pick Extensions: Install Extensions. Select the Gist Extension extension from the list.

GitHub Profiles

NOTE: You must provide a personal access token to be authenticated with GitHub or a GitHub Enterprise instance.

Press F1 and type select profile to initialize the profile selector. You can add as many profiles as you would like.

vscode-gist-profiles

If you are using a GitHub Enterprise account, be sure to add the appropriate API url. This extension uses the REST v3 API by GitHub. Your GHE API url should look similar to this: http(s)://[hostname]/api/v3 (documentation)

Usage

Create Gists

You must have a file open and active to create a gist.

Press F1 and enter the following:

GIST: Create New Gist

You will be prompted a gist description.

Open/Edit Gists

Press F1 and enter one fo the following:

GIST: Open Gist
GIST: Open Favorite Gist

All files associated with the gist will be opened in group layout.

Once you have opened an owned* gist, saving it will commit a new revision.

* an owned gist is one created by you, not a favorited (starred) gist.

You can also use the following commands:

GIST: Delete Gist
GIST: Delete File
GIST: Add File
GIST: Open Gist In Browser
GIST: Insert Text From Gist File

Extension Settings

Mostly you will not need to change these settings.

Setting Type Default Value Purpose
maxFiles Number 10 The maximum number of files to open without a prompt.
defaultPrivate Boolean false Defaults all newly created Gists to PRIVATE.
profileOptions Object {} Override profile configuration options.

profileOptions gives you some debugging capabilities. You can provide a profile name along with key, url, and rejectUnauthorized values. Before you can use profileOptions you *MUST* have the profile created.

interface ProfileOptions {
    key?: string; // the personal access token to use
    url?: string; // the REST endpoint to use
    rejectUnauthorized?: boolean; // set this to false if you are having ssl issues with your enterprise REST endpoint
}

An example value for profileOptions would be something like this:

{
    "GHE": { // "GHE" MUST correspond with the name used when originally configuring the profile
        "rejectUnauthorized": false
    }
}

All Commands & Keyboard Mappings

Here is a list of commands and their mapped keyboard shortcuts

Command Command Pallet Label Keyboard Mapping Notes
extension.gist.open Open Gist ctrl+alt+o
extension.gist.openFavorite Open Favorite Gist not mapped
extension.gist.create Create New Gist not mapped
extension.gist.openInBrowser Open Gist In Browser ctrl+alt+b
extension.gist.delete Delete Gist not mapped
extension.gist.deleteFile Delete File not mapped
extension.gist.add Add File ctrl+alt+a ctrl+alt+a
extension.gist.insert Insert Text From Gist File not mapped
extension.profile.select Select Profile ctrl+alt+=
extension.resetState n/a ctrl+shift+0 Delete All Extension Memory (removes auth tokens)

Show Your Support

If you'd like to support Gist, please consider the following — feel free to choose more than one. 😉

Maintainer

vscode-gist is maintained by Ken Howard.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.