From d09bfba5e1f16b6c679b5a91a2d530ae893c8e92 Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Fri, 3 Aug 2018 20:47:46 +0800 Subject: [PATCH] Update sudo layer doc (#2011) * Update sudo layer doc * Update sudo layer doc * Update wiki --- docs/documentation.md | 3 ++- docs/layers/sudo.md | 34 ++++++++++++++++++++++++++++++++++ wiki/en/Following-HEAD.md | 1 + 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/layers/sudo.md diff --git a/docs/documentation.md b/docs/documentation.md index 669378a8e..6436b24e0 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -1085,7 +1085,8 @@ Files manipulation commands (start with f): | `SPC f C d` | convert file from unix to dos encoding | | `SPC f C u` | convert file from dos to unix encoding | | `SPC f D` | delete a file and the associated buffer (ask for confirmation) | -| `SPC f E` | open a file with elevated privileges (sudo edit)(TODO) | +| `SPC f E` | open a file with elevated privileges (sudo layer) (TODO) | +| `SPC f W` | save a file with elevated privileges (sudo layer) | | `SPC f f` | open file | | `SPC f F` | try to open the file under point | | `SPC f o` | open a file using the default external program(TODO) | diff --git a/docs/layers/sudo.md b/docs/layers/sudo.md new file mode 100644 index 000000000..d4a86d8ac --- /dev/null +++ b/docs/layers/sudo.md @@ -0,0 +1,34 @@ +--- +title: "SpaceVim sudo layer" +description: "sudo layer provides ability to read and write file elevated privileges in SpaceVim" +--- + +# [Available Layers](../) >> sudo + + + +- [Description](#description) +- [Install](#install) +- [Key bindings](#key-bindings) + + + +## Description + +sudo layer provides ability to read and write file elevated privileges. + +## Install + +To use this configuration layer, update custom configuration file with: + +```toml +[[layers]] + name = "sudo" +``` + +## Key bindings + +| Key Binding | Description | +| ----------- | ------------------------------------ | +| `SPC f E` | open a file with elevated privileges (TODO) | +| `SPC f W` | save a file with elevated privileges | diff --git a/wiki/en/Following-HEAD.md b/wiki/en/Following-HEAD.md index 4d067aa4c..56147b715 100644 --- a/wiki/en/Following-HEAD.md +++ b/wiki/en/Following-HEAD.md @@ -70,6 +70,7 @@ The next release is v0.9.0. - Update doc for bootstrap function ([#1980](https://github.com/SpaceVim/SpaceVim/pull/1980)) - Update doc for debug upstream plugins ([#1981](https://github.com/SpaceVim/SpaceVim/pull/1981)) - Update doc windows key bindings ([#1995](https://github.com/SpaceVim/SpaceVim/pull/1995)) +- Add doc for sudo layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011)) ### Others