Add lang#puppet layer doc (#2198)

2025-01-23 13:40:05 +08:00 · 2018-09-25 23:06:21 +08:00 · 2018-09-25 23:06:21 +08:00 · 4af37296a1
commit 4af37296a1
parent 567c73f3df
6 changed files with 73 additions and 1 deletions
--- a/autoload/SpaceVim/layers/lang/puppet.vim
+++ b/autoload/SpaceVim/layers/lang/puppet.vim
@ -20,7 +20,7 @@

 function! SpaceVim#layers#lang#puppet#plugins() abort
    let plugins = []
-    call add(plugins, ['voxpupuli/vim-puppet', { 'on_ft' : 'puppet', 'loadconf_before' : 1}])
+    call add(plugins, ['rodjek/vim-puppet', { 'on_ft' : 'puppet', 'loadconf_before' : 1}])
    return plugins
 endfunction

--- a/docs/cn/layers.md
+++ b/docs/cn/layers.md
@ -110,6 +110,7 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管
 | [lang#perl](lang/perl/)               | 这一模块为 perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。                                                                  |
 | [lang#php](lang/php/)                 | 这一模块为 php 开发提供支持，包括代码补全、语法检查、代码格式化等特性。                                                                   |
 | [lang#plantuml](lang/plantuml/)       | 这一模块为 plantuml 开发提供支持，包括语法高亮、实时预览等特性。                                                                          |
+| [lang#puppet](lang/puppet/)           | 该模块为 SpaceVim 提供了 puppet 语言开发支持，包括语法高亮、语言服务器支持。                                                              |
 | [lang#purescript](lang/purescript/)   | 这一模块为 purescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。                                                            |
 | [lang#python](lang/python/)           | 这一模块为 python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。                                                                |
 | [lang#ruby](lang/ruby/)               | 这一模块为 ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。                                                                  |
--- a/docs/cn/layers/lang/puppet.md
+++ b/docs/cn/layers/lang/puppet.md
@ -0,0 +1,35 @@
+---
+title: "SpaceVim lang#puppet 模块"
+description: "该模块为 SpaceVim 提供了 puppet 语言开发支持，包括语法高亮、语言服务器支持。"
+image: https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png
+lang: cn
+---
+
+# [可用模块](../../) >> lang#puppet
+
+<!-- vim-markdown-toc GFM -->
+
+- [模块简介](#模块简介)
+- [功能特性](#功能特性)
+- [启用模块](#启用模块)
+
+<!-- vim-markdown-toc -->
+
+## 模块简介
+
+该模块为 SpaceVim 提供了 puppet 语言开发支持。
+
+![puppet ide](https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png)
+
+## 功能特性
+
+- 语法高亮
+
+## 启用模块
+
+可通过在配置文件内加入如下配置来启用该模块：
+
+```toml
+[[layers]]
+  name = "lang#puppet"
+```
--- a/docs/layers.md
+++ b/docs/layers.md
@ -114,6 +114,7 @@ enable = false
 | [lang#perl](lang/perl/)               | This layer is for perl development, provide autocompletion, syntax checking, code format for perl file.                                                             |
 | [lang#php](lang/php/)                 | This layer adds PHP language support to SpaceVim                                                                                                                    |
 | [lang#plantuml](lang/plantuml/)       | This layer is for plantuml development, syntax highlighting for plantuml file.                                                                                      |
+| [lang#puppet](lang/puppet/)           | This layer adds puppet language support to SpaceVim                                                                                                                 |
 | [lang#purescript](lang/purescript/)   | This layer is for purescript development, provide autocompletion, syntax checking, code format for purescript file.                                                 |
 | [lang#python](lang/python/)           | This layer is for Python development, provide autocompletion, syntax checking, code format for python file.                                                         |
 | [lang#ruby](lang/ruby/)               | This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file.                                                             |
--- a/docs/layers/lang/puppet.md
+++ b/docs/layers/lang/puppet.md
@ -0,0 +1,34 @@
+---
+title: "SpaceVim lang#puppet layer"
+description: "This layer adds puppet language support to SpaceVim"
+image: https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png
+---
+
+# [Available Layers](../../) >> lang#puppet
+
+<!-- vim-markdown-toc GFM -->
+
+- [Description](#description)
+- [Features](#features)
+- [Install](#install)
+
+<!-- vim-markdown-toc -->
+
+## Description
+
+This layer adds puppet language support to SpaceVim.
+
+![puppet ide](https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png)
+
+## Features
+
+- syntax highlighting
+
+## Install
+
+To use this configuration layer, update custom configuration file with:
+
+```toml
+[[layers]]
+  name = "lang#puppet"
+```
--- a/wiki/en/Following-HEAD.md
+++ b/wiki/en/Following-HEAD.md
@ -116,6 +116,7 @@ The next release is v0.9.0.
 - 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 `lang#rust` layer ([#2052](https://github.com/SpaceVim/SpaceVim/pull/2052))
+- Add doc for `lang#puppet` layer ([#2198](https://github.com/SpaceVim/SpaceVim/pull/2198))
 - Add doc for `sudo` layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011))
 - Update key notations ([#1940](https://github.com/SpaceVim/SpaceVim/pull/1940))
 - Update getting help page in wiki ([#2025](https://github.com/SpaceVim/SpaceVim/pull/2025))