mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-04-13 13:39:09 +08:00
remove submodule
This commit is contained in:
parent
6009a4a922
commit
9c52548953
1
wiki
1
wiki
@ -1 +0,0 @@
|
||||
Subproject commit 8a52cfb7bb33df285f40e8be21fefeaf60fad727
|
1
wiki/Contribute-to-SpaceVim.md
Normal file
1
wiki/Contribute-to-SpaceVim.md
Normal file
@ -0,0 +1 @@
|
||||
Before contributing be sure to consult the [contribution guidelines](http://spacevim.org/development/#contribution-guidelines) and [conventions](http://spacevim.org/development/#conventions).
|
4
wiki/Credits--Thanks.md
Normal file
4
wiki/Credits--Thanks.md
Normal file
@ -0,0 +1,4 @@
|
||||
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
|
||||
- [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim
|
||||
- [Rafael Bodill](https://github.com/rafi) and his vim-config
|
||||
- [Bailey Ling](https://github.com/bling) and his dotvim
|
3
wiki/FAQ.md
Normal file
3
wiki/FAQ.md
Normal file
@ -0,0 +1,3 @@
|
||||
### Where should I put my configration?
|
||||
|
||||
SpaceVim load custom configuration from `~/.SpaceVim.d/init.vim`.
|
1
wiki/Features.md
Normal file
1
wiki/Features.md
Normal file
@ -0,0 +1 @@
|
||||
new features will be list here:
|
21
wiki/Home.md
Normal file
21
wiki/Home.md
Normal file
@ -0,0 +1,21 @@
|
||||
- [Introduction](Introduction)
|
||||
- **[FAQ](FAQ)**
|
||||
- [Progress/Roadmap](Progress)
|
||||
- [Features](Features)
|
||||
- [Project layout](project_layout)
|
||||
|
||||
## Users
|
||||
|
||||
- [Documentation](https://spacevim.org/documentation)
|
||||
- [Quick start guide](quick-start-guide)
|
||||
- [Getting Help](getting-help)
|
||||
- [Install](Installing-SpaceVim)
|
||||
- [Update](Update)
|
||||
- [Community](http://spacevim.org/community/)
|
||||
|
||||
## Developers
|
||||
|
||||
- [Support SpaceVim](support-spacevim)
|
||||
- [contribute to SpaceVim](contribute-to-spacevim)
|
||||
- [Write post about SpaceVim](write-post-about-spacevim)
|
||||
- [Credits & Thanks](credits--thanks)
|
49
wiki/Installing-SpaceVim.md
Normal file
49
wiki/Installing-SpaceVim.md
Normal file
@ -0,0 +1,49 @@
|
||||
### 1. Requirements
|
||||
|
||||
**1) Powerline font:**
|
||||
|
||||
By defalut SpaceVim use [DejaVu Sans Mono for Powerline](https://github.com/powerline/fonts/tree/master/DejaVuSansMono), to make statusline render correctly, you need to install the font. [powerline extra symbols](https://github.com/ryanoasis/powerline-extra-symbols) also should be installed. To show the filetype icon in the tabline, you need to install [nerd-fonts](https://github.com/ryanoasis/nerd-fonts).
|
||||
|
||||
**2) Vim 7.4 above or neovim:**
|
||||
|
||||
- [neovim installation](https://github.com/neovim/neovim/wiki/Installing-Neovim)
|
||||
|
||||
- [install vim with python, python3 and lua support](https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source)
|
||||
|
||||
**3) git:**
|
||||
|
||||
SpaceVim will download all plugins via git.
|
||||
|
||||
### 2. Install SpaceVim in Linux/Mac
|
||||
|
||||
Install SpaceVim with the command below:
|
||||
|
||||
```bash
|
||||
curl -sLf https://spacevim.org/install.sh | bash
|
||||
```
|
||||
|
||||
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
|
||||
|
||||
for more info about the install script, please check:
|
||||
|
||||
```bash
|
||||
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
|
||||
```
|
||||
|
||||
### 3. Install SpaceVim in windows
|
||||
|
||||
- For vim in windows, please just clone this repo as vimfiles in you Home directory.
|
||||
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
|
||||
make sure you have a backup of your own vimfiles. also you need remove `~/_vimrc` in your home directory.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
|
||||
```
|
||||
|
||||
- For neovim in windows, please clone this repo as `AppData\Local\nvim` in your home directory.
|
||||
for more info, please check out [neovim's wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim).
|
||||
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
|
||||
```
|
11
wiki/Introduction.md
Normal file
11
wiki/Introduction.md
Normal file
@ -0,0 +1,11 @@
|
||||
## Introduction
|
||||
|
||||
[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a community-driven vim distribution with a bundle of modular configuration,
|
||||
here we call these modules as layers, each layer has different plugins and config, users just need
|
||||
to select the layers they need. It got inspired by [spacemacs](https://github.com/syl20bnr/spacemacs). If you use SpaceVim,
|
||||
please star it on github. It's a great way of getting feedback and gives me the kick to
|
||||
put more time into development.
|
||||
|
||||

|
||||
|
||||
If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore).
|
1
wiki/Progress.md
Normal file
1
wiki/Progress.md
Normal file
@ -0,0 +1 @@
|
||||
See the [Roadmap](https://spacevim.org/roadmap/) and [<kbd>:help SpaceVim-features</kbd>](https://spacevim.org/doc/user/vim_diff.html#nvim-features).
|
15
wiki/Support-SpaceVim.md
Normal file
15
wiki/Support-SpaceVim.md
Normal file
@ -0,0 +1,15 @@
|
||||
The best way to support SpaceVim is to contribute to it either by reporting bugs, helping the community on the Gitter Chat or sending pull requests.
|
||||
|
||||
If you want to show your support financially you can contribute to [Bountysource](https://www.bountysource.com/teams/spacevim) or buy a drink for the maintainer by clicking following icon.
|
||||
|
||||
<a href='https://ko-fi.com/A538L6H' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi4.png?v=f' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
|
||||
|
||||
If you used SpaceVim in a project and you want to show that fact, you can use the SpaceVim badge:
|
||||
|
||||
[](https://spacevim.org)
|
||||
|
||||
markdown
|
||||
|
||||
```md
|
||||
[](https://spacevim.org)
|
||||
```
|
7
wiki/Update.md
Normal file
7
wiki/Update.md
Normal file
@ -0,0 +1,7 @@
|
||||
Read <kbd>:h SPUpdate</kbd>, for example you can update SpaceVim with the command below:
|
||||
|
||||
```viml
|
||||
:SPUpdate SpaceVim
|
||||
```
|
||||
after updating done, you will see:
|
||||

|
1
wiki/Write-post-about-SpaceVim.md
Normal file
1
wiki/Write-post-about-SpaceVim.md
Normal file
@ -0,0 +1 @@
|
||||
if you want to write something about SpaceVim, and want your post be linked in [SpaceVim's blog page](https://spacevim.org/blog), please show us the link.
|
1
wiki/_Footer.md
Normal file
1
wiki/_Footer.md
Normal file
@ -0,0 +1 @@
|
||||
This is the _SpaceVim_ wiki. [Wiki Home](https://github.com/SpaceVim/SpaceVim/wiki)
|
15
wiki/_Sidebar.md
Normal file
15
wiki/_Sidebar.md
Normal file
@ -0,0 +1,15 @@
|
||||
[[[https://github.com/SpaceVim/SpaceVim/raw/dev/docs/logo.png|alt=SpaceVim home]]](Home)
|
||||
--
|
||||
[Introduction](Introduction)
|
||||
[Community](https://spacevim.org/community/)
|
||||
[FAQ](FAQ)
|
||||
[Layers](https://spacevim.org/layers/)
|
||||
|
||||
**Users**
|
||||
[Install](Installing-SpaceVim)
|
||||
[Docs](http://spacevim.org/documentation/)
|
||||
|
||||
**Developers**
|
||||
[Contribute](https://spacevim.org/development/)
|
||||
[Tips & Tools](Development-tips)
|
||||
[Code style](http://spacevim.org/conventions/)
|
11
wiki/async.sh
Executable file
11
wiki/async.sh
Executable file
@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
|
||||
cd wiki/
|
||||
git init
|
||||
git add .
|
||||
git commit -m "Update wiki"
|
||||
git remote add origin https://github.com/SpaceVim/SpaceVim.wiki.git
|
||||
git push -f -u origin master
|
||||
cd ..
|
||||
rm -rf ./wiki/.git/
|
1
wiki/getting-help.md
Normal file
1
wiki/getting-help.md
Normal file
@ -0,0 +1 @@
|
||||
If you need help, ask your question in the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim), a member of the community will help you out.
|
11
wiki/project_layout.md
Normal file
11
wiki/project_layout.md
Normal file
@ -0,0 +1,11 @@
|
||||
This is the project layout of SpaceVim org:
|
||||
|
||||
| Repo name | Description |
|
||||
| ----------------------------------------------------------------------- | ---------------------------------------- |
|
||||
| [SpaceVim/SpaceVim](https://github.com/SpaceVim/SpaceVim) | SpaceVim main repo |
|
||||
| [SpaceVim/unite-ctags](https://github.com/SpaceVim/unite-ctags) | A fork of voi/unite-ctags |
|
||||
| [SpaceVim/gtags.vim](https://github.com/SpaceVim/gtags.vim) | SpaceVim tags layer: gtags.vim |
|
||||
| [SpaceVim/cscope.vim](https://github.com/SpaceVim/cscope.vim) | A cscope plugin for vim/neovim |
|
||||
| [SpaceVim/vim-swig](https://github.com/SpaceVim/vim-swig) | Swig vim syntax highlighting |
|
||||
| [SpaceVim/vim-luacomplete](https://github.com/SpaceVim/vim-luacomplete) | lua complete plugin for vim |
|
||||
| [SpaceVim/unite-unicode](https://github.com/SpaceVim/unite-unicode) | Unite.vim plugin to insert unicode gyphs |
|
59
wiki/quick-start-guide.md
Normal file
59
wiki/quick-start-guide.md
Normal file
@ -0,0 +1,59 @@
|
||||
### Quick start guide
|
||||
|
||||
SpaceVim load custom configuration from `~/.SpaceVim.d/init.vim`,
|
||||
|
||||
:warning: It is not `~/.SpaceVim/init.vim`, user should not change anything in `~/.SpaceVim/`.
|
||||
|
||||
here is an example:
|
||||
|
||||
```viml
|
||||
" Here are some basic customizations, please refer to the ~/.SpaceVim.d/init.vim
|
||||
" file for all possible options:
|
||||
let g:spacevim_default_indent = 3
|
||||
let g:spacevim_max_column = 80
|
||||
|
||||
" Change the default directory where all miscellaneous persistent files go.
|
||||
" By default it is ~/.cache/vimfiles/.
|
||||
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles/'
|
||||
|
||||
" set SpaceVim colorscheme
|
||||
let g:spacevim_colorscheme = 'jellybeans'
|
||||
|
||||
" Set plugin manager, you want to use, default is dein.vim
|
||||
let g:spacevim_plugin_manager = 'dein' " neobundle or dein or vim-plug
|
||||
|
||||
" use space as `<Leader>`
|
||||
" let mapleader = "\<space>"
|
||||
|
||||
" Set windows shortcut leader [Window], default is `s`
|
||||
let g:spacevim_windows_leader = 's'
|
||||
|
||||
" Set unite work flow shortcut leader [Unite], default is `f`
|
||||
let g:spacevim_unite_leader = 'f'
|
||||
|
||||
" By default, language specific plugins are not loaded. This can be changed
|
||||
" with the following, then the plugins for go development will be loaded.
|
||||
call SpaceVim#layers#load('lang#go')
|
||||
|
||||
" loaded ui layer
|
||||
call SpaceVim#layers#load('ui')
|
||||
|
||||
" If there is a particular plugin you don't like, you can define this
|
||||
" variable to disable them entirely:
|
||||
let g:spacevim_disabled_plugins=[
|
||||
\ ['junegunn/fzf.vim'],
|
||||
\ ]
|
||||
|
||||
" If you want to add some custom plugins, use these options:
|
||||
let g:spacevim_custom_plugins = [
|
||||
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}],
|
||||
\ ['wsdjeg/GitHub.vim'],
|
||||
\ ]
|
||||
|
||||
" set the guifont
|
||||
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
|
||||
```
|
||||
|
||||
Comprehensive documentation is available for each layer by <kbd>:h SpaceVim</kbd>.
|
||||
|
||||
You can also check the [general documentation](http://spacevim.org/documentation/).
|
Loading…
x
Reference in New Issue
Block a user