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

Update markdown layer doc

Browse Source
This commit is contained in:
wsdjeg 2017-08-31 23:03:25 +00:00
parent e208f8c83a
commit 28dd7e8125
1 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,12 +1,39 @@
# [Layers](https://spacevim.org/layers) > lang#markdown
---
title: "SpaceVim lang#markdown layer"
---
# [SpaceVim Layers:](https://spacevim.org/layers) lang#markdown
<!-- vim-markdown-toc GFM -->
* [Description](#description)
* [Layer Installation](#layer-installation)
* [formatting](#formatting)
* [Key bindings](#key-bindings)
<!-- vim-markdown-toc -->
## Description
This layer is for editing markdown file.
Mappings
## Layer Installation
Key | mode | description
--- | --- | ------------
SPC l ft | Normal | Format table under cursor
SPC l p | Normal | Real-time markdown preview
To use this configuration layer, add `call SpaceVim#layers#load('lang#markdown')` to your custom configuration file.
## formatting
SpaceVim use remark to formatting markdown file, so you need to install this program. you can install it via npm:
```sh
npm -g install remark
npm -g install remark-cli
npm -g install remark-stringify
```
## Key bindings
| Key | mode | description |
| ---------- | ------ | -------------------------- |
| `SPC b f` | Normal | Format current buffer |
| `SPC l ft` | Normal | Format table under cursor |
| `SPC l p` | Normal | Real-time markdown preview |