1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-03-22 08:45:42 +08:00

📝 Update getting help page in wiki (#2025)

This commit is contained in:
Wang Shidong 2018-08-16 21:21:53 +08:00 committed by GitHub
parent d03a3e2403
commit 1ee76aeab7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 39 additions and 10 deletions

View File

@ -1,10 +1,10 @@
[![SpaceVim](https://spacevim.org/logo.png)](https://spacevim.org) [![SpaceVim](https://spacevim.org/logo.png)](https://spacevim.org)
[Wiki](https://github.com/SpaceVim/SpaceVim/wiki) \| [Wiki](https://github.com/SpaceVim/SpaceVim/wiki) \|
[Documentation](http://spacevim.org/documentation/) \| [Documentation](https://spacevim.org/documentation/) \|
[Twitter](https://twitter.com/SpaceVim) \| [Twitter](https://twitter.com/SpaceVim) \|
[Community](https://spacevim.org/community/) \| [Community](https://spacevim.org/community/) \|
[Sponsors](http://spacevim.org/sponsors/) \| [Sponsors](https://spacevim.org/sponsors/) \|
[Gitter **Chat**](https://gitter.im/SpaceVim/SpaceVim) \| [Gitter **Chat**](https://gitter.im/SpaceVim/SpaceVim) \|
[中文官网](https://spacevim.org/cn/) [中文官网](https://spacevim.org/cn/)
@ -25,7 +25,9 @@ SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many
The last release is v0.8.0, check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release. The last release is v0.8.0, check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release.
See the [quick start guide](https://spacevim.org/quick-start-guide/), [documentation](https://spacevim.org/documentation/) or the [available layers](http://spacevim.org/layers/) for more information. See the [quick start guide](https://spacevim.org/quick-start-guide/), [documentation](https://spacevim.org/documentation/) or the [available layers](https://spacevim.org/layers/) for more information.
If you have any questions about SpaceVim, please follow the [Getting Help guide](https://github.com/SpaceVim/SpaceVim/wiki/Getting-help).
Here is a throughput graph of the repository for the last few weeks: Here is a throughput graph of the repository for the last few weeks:
@ -108,20 +110,20 @@ through search tools: `ag`, `rg`, `ack`, `pt` and `grep`, Choose one you like.
![searching project](https://user-images.githubusercontent.com/13142418/35278709-7856ed62-0010-11e8-8b1e-e6cc6374b0dc.gif) ![searching project](https://user-images.githubusercontent.com/13142418/35278709-7856ed62-0010-11e8-8b1e-e6cc6374b0dc.gif)
[**Mnemonic key bindings navigation**](http://spacevim.org/mnemonic-key-bindings-navigation/) [**Mnemonic key bindings navigation**](https://spacevim.org/mnemonic-key-bindings-navigation/)
You don't need to remember any key bindings, as the mapping guide will show up after the <kbd>SPC</kbd> is pressed. You don't need to remember any key bindings, as the mapping guide will show up after the <kbd>SPC</kbd> is pressed.
The mapping guide is also available for `g`, `z`, and `s`. The mapping guide is also available for `g`, `z`, and `s`.
![mapping guide](https://user-images.githubusercontent.com/13142418/35568184-9a318082-058d-11e8-9d88-e0eafd1d498d.gif) ![mapping guide](https://user-images.githubusercontent.com/13142418/35568184-9a318082-058d-11e8-9d88-e0eafd1d498d.gif)
[**Help description for key bindings**](http://spacevim.org/help-description-for-key-bindings/) [**Help description for key bindings**](https://spacevim.org/help-description-for-key-bindings/)
use <kbd>SPC h d k</kbd> to get the help description of a key binding, and `gd` to find definition of key bindings. use <kbd>SPC h d k</kbd> to get the help description of a key binding, and `gd` to find definition of key bindings.
![describe key bindings](https://user-images.githubusercontent.com/13142418/35568829-e3c8e74c-058f-11e8-8fa8-c0e046d8add3.gif) ![describe key bindings](https://user-images.githubusercontent.com/13142418/35568829-e3c8e74c-058f-11e8-8fa8-c0e046d8add3.gif)
[**Asynchronous plugin manager**](http://spacevim.org/Asynchronous-plugin-manager/) [**Asynchronous plugin manager**](https://spacevim.org/Asynchronous-plugin-manager/)
create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager
@ -152,7 +154,7 @@ For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/)
The best way to support SpaceVim is to contribute to it either by reporting bugs, The best way to support SpaceVim is to contribute to it either by reporting bugs,
helping the community on the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim) or sending pull requests. helping the community on the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim) or sending pull requests.
For more info please check our [development guidelines](http://spacevim.org/development/). For more info please check our [development guidelines](https://spacevim.org/development/).
If you want to show your support financially you can buy a drink for the maintainer by If you want to show your support financially you can buy a drink for the maintainer by
clicking following icon. clicking following icon.

View File

@ -84,6 +84,7 @@ The next release is v0.9.0.
- Update doc windows key bindings ([#1995](https://github.com/SpaceVim/SpaceVim/pull/1995)) - Update doc windows key bindings ([#1995](https://github.com/SpaceVim/SpaceVim/pull/1995))
- Add doc for sudo layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011)) - Add doc for sudo layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011))
- Update key notations ([#1940](https://github.com/SpaceVim/SpaceVim/pull/1940)) - Update key notations ([#1940](https://github.com/SpaceVim/SpaceVim/pull/1940))
- Update getting help page in wiki ([#2025](https://github.com/SpaceVim/SpaceVim/pull/2025))
### Others ### Others

26
wiki/en/Getting-help.md Normal file
View File

@ -0,0 +1,26 @@
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.
Here is a simple guide for how to get help with SpaceVim. Before asking
questions, please read the [FAQ](https://spacevim.org/faq/), the answer
to your question may be listed there.
### Transitioning to init.toml
If you are not new to Vim, and you are familiar with your own vim
config, we recommend to use `vimcompatible` mode, In this mode, no
original key bindings will be overriden.
### Language support
SpaceVim use language layer to to provide common IDE functionality for
any arbitrary programming language. This enables features like
- code completion
- syntax checking
- find definition and references
- code formatting
- syntax highlighting
- indent
please check out the [available layers](https://spacevim.org/layers/) for all supported languages.

View File

@ -9,10 +9,11 @@ welcome to <img src="https://spacevim.org/SpaceVim.png" height="17" width="17">
### Users ### Users
- [Getting Help](getting-help): A guide for getting help about using SpaceVim. - [Getting Help](Getting-help): A guide for getting help about using SpaceVim.
- [Quick start guide](https://spacevim.org/quick-start-guide/): A quick start guide about SpaceVim - [Quick start guide](https://spacevim.org/quick-start-guide/): A quick start guide about SpaceVim
- [Documentation](https://spacevim.org/documentation): SpaceVim Documentation - [Documentation](https://spacevim.org/documentation): SpaceVim Documentation
- [Community](http://spacevim.org/community/): Official community - [Community](http://spacevim.org/community/): Official community
- [Following HEAD](Following-HEAD)
### Developers ### Developers

View File

@ -6,7 +6,7 @@
[Layers](https://spacevim.org/layers/) [Layers](https://spacevim.org/layers/)
**Users** **Users**
[Getting Help](getting-help) [Getting Help](Getting-help)
[Docs](http://spacevim.org/documentation/) [Docs](http://spacevim.org/documentation/)
[Following HEAD](Following-HEAD) [Following HEAD](Following-HEAD)

View File

@ -1 +0,0 @@
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.