diff --git a/docs/README.md b/docs/README.md index 0da5a163f..edb8e335d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ # Introduction + [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim) ![Version 0.1.0-dev](https://img.shields.io/badge/version-0.1.0--dev-yellow.svg?style=flat-square) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE) @@ -20,9 +21,9 @@ For learning about Vim in general, read [vim-galore](https://github.com/mhinz/vi [![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput) -## Install +# Install -### Linux/Mac +## Linux/Mac ```sh curl -sLf https://spacevim.org/install.sh | bash @@ -40,7 +41,7 @@ for more info about the install script, please check: curl -sLf https://spacevim.org/install.sh | bash -s -- -h ``` -### windows support +## windows support - 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. @@ -57,23 +58,3 @@ git clone https://github.com/SpaceVim/SpaceVim.git vimfiles ```sh git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim ``` - -## File Structure -- [config](./config)/ - Configuration - - [plugins](./config/plugins)/ - Plugin configurations - - [mappings.vim](./config/mappings.vim) - Key mappings - - [autocmds.vim](./config/autocmds.vim) - autocmd group - - [general.vim](./config/general.vim) - General configuration - - [init.vim](./config/init.vim) - `runtimepath` initialization - - [neovim.vim](./config/neovim.vim) - Neovim specific setup - - [plugins.vim](./config/plugins.vim) - Plugin bundles - - [commands.vim](./config/commands.vim) - Commands - - [functions.vim](./config/functions.vim) - Functions - - [main.vim](./config/main.vim) - Main config -- [ftplugin](./ftplugin)/ - Language specific custom settings -- [snippets](../../snippets)/ - Code snippets -- [filetype.vim](./filetype.vim) - Custom filetype detection -- [init.vim](./init.vim) - Sources `config/main.vim` -- [vimrc](./vimrc) - Sources `config/main.vim` - - diff --git a/docs/about.md b/docs/about.md index 97411a544..fafcbcd21 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,4 +1,4 @@ -## About SpaceVim +# About SpaceVim [SpaceVim](https://github.com/SpaceVim/SpaceVim) is a Modular configuration, a bundle of custom settings and plugins for Vim, here we call them layers, each layer has different plugins and config, users just need @@ -11,7 +11,7 @@ report on Github. For learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore). -#### Credits & Thanks +# Credits & Thanks - [![GitHub contributors](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg)](https://github.com/SpaceVim/SpaceVim/graphs/contributors) - [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim diff --git a/docs/community.md b/docs/community.md index c79bb197f..90bea825d 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,17 +1,17 @@ -## Community +# Community Try these SpaceVim hangouts for any questions, problems or comments. -### Ask +## Ask - [issue tracker](https://github.com/SpaceVim/SpaceVim/issues) for issue and feature requests - vi StackExchange for "how to" & configuration questions - [Twitter](https://twitter.com/SpaceVim) for hugs & pithy comments -### Chat +## Chat - [![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - [![QQ](https://img.shields.io/badge/QQ群-121056965-blue.svg)](https://jq.qq.com/?_wv=1027&k=43DB6SG) - [![Facebook](https://img.shields.io/badge/FaceBook-SpaceVim-blue.svg)](https://www.facebook.com/SpaceVim) -### Discuss +## Discuss To report an issue or give feedback to the developers, please use the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues). diff --git a/docs/development.md b/docs/development.md index 1a76eb3f7..3b2a9bd8c 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,11 +1,11 @@ -## Support SpaceVim +# Support SpaceVim -### Development happens in the GitHub repository. +## Development happens in the GitHub repository. [![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://github.com/SpaceVim/SpaceVim) -### Report bugs +## Report bugs If you get any issues, please open an issue with the ISSUE_TEMPLATE. It is useful for me to debug for this issue. -### Contribute Layers +## Contribute Layers diff --git a/docs/documentation.md b/docs/documentation.md index f19c7241a..ec84a4283 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -1,4 +1,4 @@ -## SpaceVim Documentation +# SpaceVim Documentation - Features - [Awesome ui](#awesome-ui) @@ -24,16 +24,16 @@ -#### Features +## Features -##### Awesome ui +### Awesome ui - outline + filemanager + checker ![2017-02-01_1360x721](https://cloud.githubusercontent.com/assets/13142418/22506638/84705532-e8bc-11e6-8b72-edbdaf08426b.png) -##### Language specific mode +### Language specific mode -###### c/c++ support +#### c/c++ support 1. code completion: autocompletion and fuzzy match. ![2017-02-01_1359x720](https://cloud.githubusercontent.com/assets/13142418/22505960/df9068de-e8b8-11e6-943e-d79ceca095f1.png) diff --git a/docs/sponsors.md b/docs/sponsors.md index c2fb8b8c7..a4da53b9f 100644 --- a/docs/sponsors.md +++ b/docs/sponsors.md @@ -1,3 +1,3 @@ -## Current Sponsors +# Current Sponsors