1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-03 09:20:04 +08:00
SpaceVim/docs/layers/lang/markdown.md

40 lines
1006 B
Markdown
Raw Normal View History

2017-09-01 07:03:25 +08:00
---
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
2017-05-10 21:35:45 +08:00
This layer is for editing markdown file.
2017-09-01 07:03:25 +08:00
## Layer Installation
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:
2017-05-10 21:35:45 +08:00
2017-09-01 07:03:25 +08:00
```sh
npm -g install remark
npm -g install remark-cli
npm -g install remark-stringify
```
2017-05-10 21:35:45 +08:00
2017-09-01 07:03:25 +08:00
## Key bindings
2017-05-10 21:35:45 +08:00
2017-09-01 07:03:25 +08:00
| 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 |