1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 07:00:04 +08:00
SpaceVim/docs/layers/github.md
2021-06-21 20:39:29 +08:00

1.9 KiB

title description
SpaceVim github layer This layer provides GitHub integration for SpaceVim

Available Layers >> github

Description

This layer provides GitHub integration for SpaceVim.

Install

To use this configuration layer, add the following snippet to your custom configuration file.

[[layers]]
  name = "github"

Key bindings

Key Binding Description
SPC g h i show issues
SPC g h a show activities
SPC g h d show dashboard
SPC g h f show current file in browser
SPC g h I show issues in browser
SPC g h p show PRs in browser
SPC g g l list all gists
SPC g g p post a gist

Extra configuration for GitHub and Gist

To avoid needing to constantly input your username and password, you'll want to create the following Bootstrap Function in a file such as .SpaceVim.d/autoload/myspacevim.vim.

func! myspacevim#before() abort
  "other configs
  let g:github_dashboard = { 'username': 'yourgithubuser', 'password': $GITHUB_TOKEN }
  let g:gista#client#default_username = 'monkeyxite'
endf

We recommend generating a personal access token and storing it securely in an environment variable. Refer to github dashboard for more information.

# in some secure file sourced in your .bashrc, .bash_profile, .zshrc, etc.
export GITHUB_TOKEN="<your 40 char token>"