From e650dceffeb71091400e74ea39f843b9127b19de Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Tue, 25 Aug 2020 17:06:48 +0800 Subject: [PATCH] Update doc for cmdlinemenu (#3726) --- docs/api/cmdlinemenu.md | 28 ++++++++++++++++++++++++++++ docs/cn/api/cmdlinemenu.md | 15 +++++++++++++-- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/docs/api/cmdlinemenu.md b/docs/api/cmdlinemenu.md index e69de29bb..ed57223e2 100644 --- a/docs/api/cmdlinemenu.md +++ b/docs/api/cmdlinemenu.md @@ -0,0 +1,28 @@ +--- +title: "cmdlinemenu api" +description: "cmdlinemenu API provides interface for making choices in a command line." +--- + +# [Available APIs](../) >> cmdlinemenu + + + + +- [Intro](#intro) + + + +## Intro + +cmdlinemenu API provides interface for making choices in a command line. + +here is an example for using this API: + +```vim +let menu = SpaceVim#api#import('cmdlinemenu') +let ques = [ + \ ['basic mode', function('s:basic_mode')], + \ ['dark powered mode', function('s:awesome_mode')], + \ ] +call menu.menu(ques) +``` diff --git a/docs/cn/api/cmdlinemenu.md b/docs/cn/api/cmdlinemenu.md index d8dfbb0c8..6b3aff7b0 100644 --- a/docs/cn/api/cmdlinemenu.md +++ b/docs/cn/api/cmdlinemenu.md @@ -1,6 +1,6 @@ --- title: "cmdlinemenu 函数" -description: "cmdlinemenu 函数提供了基础的文件读写相关函数,兼容不同系统平台。" +description: "cmdlinemenu 函数提供了一套通过命令行进行选择的快捷接口。" lang: zh --- @@ -15,6 +15,17 @@ lang: zh ## 简介 -文件函数提供了基础的文件读写相关函数,兼容不同系统平台。 +cmdlinemenu 函数提供了一套通过命令行进行选择的快捷接口。 + +以下是一个使用该函数的示例: + +```vim +let menu = SpaceVim#api#import('cmdlinemenu') +let ques = [ + \ ['basic mode', function('s:basic_mode')], + \ ['dark powered mode', function('s:awesome_mode')], + \ ] +call menu.menu(ques) +```