Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-03 04:00:04 +08:00
Code Issues Projects Releases Wiki Activity

Fix markdown format

Browse Source
This commit is contained in:
Shidong Wang 2018-12-23 12:13:43 +08:00
parent 37bde366dc
commit 1a74d45f6d
5 changed files with 226 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -18,6 +18,7 @@
[![Percentage of issues still open](http://isitmaintained.com/badge/open/SpaceVim/SpaceVim.svg)](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open") [![Percentage of issues still open](http://isitmaintained.com/badge/open/SpaceVim/SpaceVim.svg)](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
## About SpaceVim ## About SpaceVim
SpaceVim is a community-driven modular vim distribution. It manages collections SpaceVim is a community-driven modular vim distribution. It manages collections
of plugins in layers, which help collect related packages together to provide IDE-like features. of plugins in layers, which help collect related packages together to provide IDE-like features.
SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features. SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features.

7
autoload/SpaceVim/layers/lang/markdown.vim
View File

@ -6,6 +6,9 @@
" License: GPLv3 " License: GPLv3
"============================================================================= "=============================================================================
let s:SYS = SpaceVim#api#import('system')
let s:md_listItemIndent = 1 let s:md_listItemIndent = 1
let s:md_enableWcwidth = 0 let s:md_enableWcwidth = 0
let s:md_listItemChar = '-' let s:md_listItemChar = '-'
@ -40,7 +43,11 @@ function! SpaceVim#layers#lang#markdown#config() abort
\}, \},
\} \}
let remarkrc = s:generate_remarkrc() let remarkrc = s:generate_remarkrc()
if s:SYS.isWindows
let g:neoformat_enabled_markdown = ['prettier']
else
let g:neoformat_enabled_markdown = ['remark'] let g:neoformat_enabled_markdown = ['remark']
endif
let g:neoformat_markdown_remark = { let g:neoformat_markdown_remark = {
\ 'exe': 'remark', \ 'exe': 'remark',
\ 'args': ['--no-color', '--silent'] + (empty(remarkrc) ? [] : ['-r', remarkrc]), \ 'args': ['--no-color', '--silent'] + (empty(remarkrc) ? [] : ['-r', remarkrc]),

29
docs/cn/documentation.md
View File

@ -124,10 +124,10 @@ lang: cn
- **优雅简洁的界面:** 你将会喜欢这样的优雅而实用的界面。 - **优雅简洁的界面:** 你将会喜欢这样的优雅而实用的界面。
- **确保手指不离开主键盘区域:** 使用 Space 作为前缀键，合理组织快捷键，确保手指不离开主键盘区域。 - **确保手指不离开主键盘区域:** 使用 Space 作为前缀键，合理组织快捷键，确保手指不离开主键盘区域。
- **快捷键辅助系统:** SpaceVim 所有快捷键无需记忆，当输入出现停顿，会实时提示可用按键及其功能。 - **快捷键辅助系统:** SpaceVim 所有快捷键无需记忆，当输入出现停顿，会实时提示可用按键及其功能。
- **更快的启动时间:** 得益于 dein.vim, SpaceVim 中90% 的插件都是按需载入的。 - **更快的启动时间:** 得益于 dein.vim, SpaceVim 中 90% 的插件都是按需载入的。
- **更少的肌肉损伤:** 频繁使用空格键，取代 `ctrl`，`shift` 等按键，大大减少了手指的肌肉损伤。 - **更少的肌肉损伤:** 频繁使用空格键，取代 `ctrl`，`shift` 等按键，大大减少了手指的肌肉损伤。
- **更易扩展:** 依照一些[约定](http://spacevim.org/cn/development/)，很容易将现有的插件集成到 SpaceVim 中来。 - **更易扩展:** 依照一些[约定](http://spacevim.org/cn/development/)，很容易将现有的插件集成到 SpaceVim 中来。
- **完美支持Neovim:** 依赖于 Neovim 的 romote 插件以及异步 API，SpaceVim 运行在 Neovim 下将有更加完美的体验。 - **完美支持 Neovim:** 依赖于 Neovim 的 romote 插件以及异步 API，SpaceVim 运行在 Neovim 下将有更加完美的体验。
## 运行截图 ## 运行截图
@ -309,9 +309,9 @@ SpaceVim 的[模块首页](../layers/)。
disabled_plugins = ["neomake.vim"] disabled_plugins = ["neomake.vim"]
``` ```
2. 添加自己fork的插件，或者本地克隆版本： 2. 添加自己 fork 的插件，或者本地克隆版本：
修搞配置文件 init.toml， 加入以下部分，来添加自己fork的版本： 修搞配置文件 init.toml， 加入以下部分，来添加自己 fork 的版本：
```toml ```toml
[[custom_plugins]] [[custom_plugins]]
@ -390,7 +390,7 @@ SpaceVim 在终端下默认使用了真色，因此使用之前需要确认下
| 快捷键 | 描述 | | 快捷键 | 描述 |
| ----------- | ----------------------------------------- | | ----------- | ----------------------------------------- |
| `SPC t 8` | 高亮所有超过80列的字符 | | `SPC t 8` | 高亮所有超过 80 列的字符 |
| `SPC t f` | 高亮临界列，默认 `max_column` 是第 120 列 | | `SPC t f` | 高亮临界列，默认 `max_column` 是第 120 列 |
| `SPC t h h` | 高亮当前行 | | `SPC t h h` | 高亮当前行 |
| `SPC t h i` | 高亮代码对齐线 | | `SPC t h i` | 高亮代码对齐线 |
@ -570,7 +570,7 @@ custom_color_palette = [
### 标签栏 ### 标签栏
如果只有一个Tab, Buffers 将被罗列在标签栏上，每一个包含：序号、文件类型图标、文件名。如果有不止一个 Tab, 那么所有 Tab 将被罗列在标签栏上。标签栏上每一个 Tab 或者 Buffer 可通过快捷键 `<Leader> number` 进行快速访问，默认的 `<Leader>` 是 `\`。 如果只有一个 Tab, Buffers 将被罗列在标签栏上，每一个包含：序号、文件类型图标、文件名。如果有不止一个 Tab, 那么所有 Tab 将被罗列在标签栏上。标签栏上每一个 Tab 或者 Buffer 可通过快捷键 `<Leader> number` 进行快速访问，默认的 `<Leader>` 是 `\`。
| 快捷键 | 描述 | | 快捷键 | 描述 |
| ------------ | ---------------- | | ------------ | ---------------- |
@ -890,8 +890,8 @@ merged = 0
类似于 Firefox 的 vimperator 的 `f` 键的功能。 类似于 Firefox 的 vimperator 的 `f` 键的功能。
| 快捷键 | 描述 | | 快捷键 | 描述 |
| ------------------------------- | ---------------- | | ------------------------------- | ----------------- |
| `SPC j u`/(`o` for help buffer) | 快速跳到/打开url | | `SPC j u`/(`o` for help buffer) | 快速跳到/打开 url |
#### 常用的成对快捷键 #### 常用的成对快捷键
@ -1021,7 +1021,7 @@ Buffer 操作相关快捷键都是已 `SPC b` 为前缀的：
| 快捷键 | 描述 | | 快捷键 | 描述 |
| --------------- | ------------------------------------------------------------------------------ | | --------------- | ------------------------------------------------------------------------------ |
| `SPC TAB` | 切换至前一buffer，可用于两个 buffer 来回切换 | | `SPC TAB` | 切换至前一 buffer，可用于两个 buffer 来回切换 |
| `SPC b .` | 启用 buffer 临时快捷键 | | `SPC b .` | 启用 buffer 临时快捷键 |
| `SPC b b` | 切换至某一 buffer，通过 Unite/Denite 进行筛选 | | `SPC b b` | 切换至某一 buffer，通过 Unite/Denite 进行筛选 |
| `SPC b d` | 删除当前 buffer，但保留 Vim 窗口 | | `SPC b d` | 删除当前 buffer，但保留 Vim 窗口 |
@ -1173,7 +1173,7 @@ SpaceVim 的文件树提供了版本控制信息的接口，但是这一特性
| `g]` | tselect cursor tag | | `g]` | tselect cursor tag |
| `g^` | go to leftmost no-white character | | `g^` | go to leftmost no-white character |
| `g_` | go to last char | | `g_` | go to last char |
| ``g` `` | 跳至标签，等同于 `g'` | | `` g` `` | 跳至标签，等同于 `g'` |
| `ga` | 打印光标字符的 ascii 值 | | `ga` | 打印光标字符的 ascii 值 |
| `gd` | 跳至定义处 | | `gd` | 跳至定义处 |
| `ge` | go to end of previous word | | `ge` | go to end of previous word |
@ -1321,13 +1321,12 @@ endfunction
" } " }
``` ```
##### 常用按键绑定 ##### 常用按键绑定
| Key Binding | Description | | Key Binding | Description |
| --------------- | ----------------------------------------- | | --------------- | ----------------------------------------- |
| `SPC r l` | resume the last completion buffer | | `SPC r l` | resume the last completion buffer |
| ``SPC s ` `` | go back to the previous place before jump | | `` SPC s ` `` | go back to the previous place before jump |
| Prefix argument | will ask for file extensions | | Prefix argument | will ask for file extensions |
##### 在当前文件中进行搜索 ##### 在当前文件中进行搜索
@ -1411,7 +1410,7 @@ endfunction
| `SPC s r p` | rg | | `SPC s r p` | rg |
| `SPC s r P` | rg with default text | | `SPC s r P` | rg with default text |
**提示**: 在工程中进行搜索的话, 无需提前打开文件. 在工程保存目录中使用 `SPC　p p` 和　`C-s`　，　就比如 `SPC s p`.(TODO)　 **提示**: 在工程中进行搜索的话, 无需提前打开文件. 在工程保存目录中使用 `SPC p p` 和　`C-s`　，　就比如 `SPC s p`.(TODO)
##### 后台进行工程搜索 ##### 后台进行工程搜索
@ -1440,7 +1439,7 @@ endfunction
| `SPC s w g` | Get Google suggestions in vim. Opens Google results in Browser. | | `SPC s w g` | Get Google suggestions in vim. Opens Google results in Browser. |
| `SPC s w w` | Get Wikipedia suggestions in vim. Opens Wikipedia page in Browser.(TODO) | | `SPC s w w` | Get Wikipedia suggestions in vim. Opens Wikipedia page in Browser.(TODO) |
**注意**: 为了在　vim　中使用谷歌　suggestions ，　你需要在你的默认配置文件中加入　`let g:spacevim_enable_googlesuggest = 1`. **注意**: 为了在　 vim 　中使用谷歌　 suggestions ，　你需要在你的默认配置文件中加入　`let g:spacevim_enable_googlesuggest = 1`.
#### 实时代码检索 #### 实时代码检索
@ -1715,7 +1714,7 @@ SpaceVim 通过 [neomake](https://github.com/neomake/neomake) fly 工具来进
| `SPC e .` | error transient state | | `SPC e .` | error transient state |
下一个/上一个错误导航键和错误暂态(error transinet state) 可用于浏览语法检查器和位置列表缓冲区的错误, 下一个/上一个错误导航键和错误暂态(error transinet state) 可用于浏览语法检查器和位置列表缓冲区的错误,
甚至可检查vim位置列表的所有错误. 这包括下面的例子: 在已被保存的位置列表缓冲区进行搜索. 甚至可检查 vim 位置列表的所有错误. 这包括下面的例子: 在已被保存的位置列表缓冲区进行搜索.
默认提示符: 默认提示符:
| Symbol | Description | Custom option | | Symbol | Description | Custom option |

10
docs/documentation.md
View File

@ -1219,7 +1219,7 @@ which will tell you the functional of all mappings starting with `g`.
| `g ]` | tselect cursor tag | | `g ]` | tselect cursor tag |
| `g ^` | go to leftmost no-white character | | `g ^` | go to leftmost no-white character |
| `g _` | go to last char | | `g _` | go to last char |
| ``g ` `` | jump to mark | | `` g ` `` | jump to mark |
| `g a` | print ascii value of cursor character | | `g a` | print ascii value of cursor character |
| `g d` | goto definition | | `g d` | goto definition |
| `g e` | go to end of previous word | | `g e` | go to end of previous word |
@ -1336,7 +1336,6 @@ Notes:
**Beware** if you use `pt`, [TCL parser tools](https://core.tcl.tk/tcllib/doc/trunk/embedded/www/tcllib/files/apps/pt.html) also install a command line tool called `pt`. **Beware** if you use `pt`, [TCL parser tools](https://core.tcl.tk/tcllib/doc/trunk/embedded/www/tcllib/files/apps/pt.html) also install a command line tool called `pt`.
##### Custom searching tool ##### Custom searching tool
to change the option of a search tool, you need to use bootstrap function. here is an example to change the option of a search tool, you need to use bootstrap function. here is an example
@ -1366,13 +1365,12 @@ The structure of searching tool profile is:
" } " }
``` ```
##### Useful key bindings ##### Useful key bindings
| Key Binding | Description | | Key Binding | Description |
| --------------- | ----------------------------------------- | | --------------- | ----------------------------------------- |
| `SPC r l` | resume the last completion buffer | | `SPC r l` | resume the last completion buffer |
| ``SPC s ` `` | go back to the previous place before jump | | `` SPC s ` `` | go back to the previous place before jump |
| Prefix argument | will ask for file extensions | | Prefix argument | will ask for file extensions |
##### Searching in current file ##### Searching in current file
@ -1708,14 +1706,14 @@ The default color for iedit is `red`/`green` which is based on the current color
Comments are handled by [nerdcommenter](https://github.com/scrooloose/nerdcommenter), it’s bound to the following keys. Comments are handled by [nerdcommenter](https://github.com/scrooloose/nerdcommenter), it’s bound to the following keys.
| Key Binding | Description | | Key Binding | Description |
| ----------- | ------------------------- | | ----------- | -------------------------- |
| `SPC ;` | comment operator | | `SPC ;` | comment operator |
| `SPC c h` | hide/show comments | | `SPC c h` | hide/show comments |
| `SPC c l` | comment lines | | `SPC c l` | comment lines |
| `SPC c L` | invert comment lines | | `SPC c L` | invert comment lines |
| `SPC c p` | comment paragraphs | | `SPC c p` | comment paragraphs |
| `SPC c P` | invert comment paragraphs | | `SPC c P` | invert comment paragraphs |
| `SPC c s` | comment with pretty layout| | `SPC c s` | comment with pretty layout |
| `SPC c t` | comment to line | | `SPC c t` | comment to line |
| `SPC c T` | invert comment to line | | `SPC c T` | invert comment to line |
| `SPC c y` | comment and yank | | `SPC c y` | comment and yank |

1
docs/layers/lang/markdown.md
View File

@ -56,7 +56,6 @@ Enable/Disable wcwidth for detecting the length of a table cell, default is 0. T
Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`). Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`).
## Key bindings ## Key bindings
| Key | mode | description | | Key | mode | description |