1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 13:10:04 +08:00

Doc: update markdown documents. (#4162)

Co-authored-by: Kun Lin <ssfjhh@gmail.com>
This commit is contained in:
Lin Kun 2021-04-03 19:59:14 +08:00 committed by GitHub
parent da5e3205c4
commit b64eb80789
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 7 deletions

View File

@ -12,6 +12,7 @@ lang: zh
- [启用模块](#启用模块)
- [代码格式化](#代码格式化)
- [模块设置](#模块设置)
- [标签栏](#标签栏)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
@ -36,6 +37,7 @@ lang: zh
SpaceVim 默认使用 remark 来格式化 Markdown 文件Windows 下建议使用 [Prettier](https://github.com/prettier/prettier) 来格式化 Markdown 文件。
remark 可通过 [npm](https://www.npmjs.com/get-npm) 命令来安装:
```sh
npm -g install remark
npm -g install remark-cli
@ -44,13 +46,18 @@ npm -g install remark-frontmatter
npm -g install wcwidth
```
默认值是 remark 而不是 prettier如果您想使用 prettier你需要修改此模块的选项`enable_formater`。
[Prettier](https://github.com/prettier/prettier) 可通过 [yarn](https://yarnpkg.com/lang/zh-hans/docs/install/#windows-stable) 或 [npm](https://www.npmjs.com/get-npm) 命令来安装:
1. 通过 `yarn` 命令来安装
```sh
yarn global add prettier
```
2. 通过 `npm` 命令来安装
```sh
npm install --global prettier
```
@ -73,11 +80,21 @@ npm install --global prettier
设置无序列表前缀 (`'-'`, `'*'`, or `'+'`, 默认: `'-'`)。
**enabled_formater**
为 markdown 文件指定启用的格式化工具,默认值是`["remark"]`,您也可以添加其它格式化工具到此列表,例如:`["remark", "prettier"]`。
## 标签栏
为了在标签栏中显示标题(使用<kbd>F2</kbd>切换),请确保 php 在你的环境变量`$PATH`中,在 SpaceVim 中,您可以这样测试:`:!php --version`,如果 php 安装成功,此命令应该会显示一些 php 的信息。
如果不希望安装 php也可以直接下载 [mdctags](https://github.com/wsdjeg/mdctags.rs) 命令。
## 快捷键
| 快捷键 | 模式 | 按键描述 |
| ---------- | ------------- | -------------------------------------- |
| `SPC b f` | Normal | 格式化当前文件 |
| `SPC l k` | Normal/Visual | 为光标下的单词或者选中文本增加 URL 链接|
| `SPC l K` | Normal/Visual | 为光标下的单词或者选中文本增加图片链接 |
| `SPC l p` | Normal | 通过浏览器实时预览当前文件 |
| 快捷键 | 模式 | 按键描述 |
| --------- | ------------- | --------------------------------------- |
| `SPC b f` | Normal | 格式化当前文件 |
| `SPC l k` | Normal/Visual | 为光标下的单词或者选中文本增加 URL 链接 |
| `SPC l K` | Normal/Visual | 为光标下的单词或者选中文本增加图片链接 |
| `SPC l p` | Normal | 通过浏览器实时预览当前文件 |

View File

@ -82,7 +82,7 @@ Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`).
**enabled_formater**
Specific the enabled formater for markdown file, default is `['remark']`.
Specific the enabled formater for markdown file, default is `['remark']`. You can also append this list with other markdown formatter(s), such as `["remark", "prettier"]`.
## Tagbar