Skip to content

Commit

Permalink
Add the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Sep 25, 2023
1 parent 240130e commit 2f34d18
Show file tree
Hide file tree
Showing 3 changed files with 172 additions and 0 deletions.
77 changes: 77 additions & 0 deletions doc/dpp-ext-local.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
*dpp-ext-local.txt* Local ext for dpp.vim

Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license

CONTENTS *dpp-ext-local-contents*

Introduction |dpp-ext-local-introduction|
Install |dpp-ext-local-install|
Examples |dpp-ext-local-examples|
Actions |dpp-ext-local-actions|
Preview params |dpp-ext-local-preview-params|
Params |dpp-ext-local-params|
Compatibility |dpp-ext-local-compatibility|


==============================================================================
INTRODUCTION *dpp-ext-local-introduction*

This ext implements local operations.


==============================================================================
INSTALL *dpp-ext-local-install*

Please install both "dpp.vim" and "denops.vim".

https://github.com/Shougo/dpp.vim
https://github.com/vim-denops/denops.vim


==============================================================================
EXAMPLES *dpp-ext-local-examples*
>
const plugins = await args.dpp.extAction(args.denops, "local", "local", {
directory: "~/work",
options: {
frozen: true,
merged: false,
},
includes: [
"vim*",
"nvim-*",
"*.vim",
"*.nvim",
"ddc-*",
"dpp-*",
"skkeleton",
"neco-vim",
],
});
<

==============================================================================
ACTIONS *dpp-ext-local-actions*

*dpp-ext-local-action-local*
local
Returns local plugins.

params:
{directory}: local directory path.
(Required)
{options}: default local plugin's |dpp-options|.
(Default: {})
{includes}: {includes} directories are only
loaded.
(Default: [])

==============================================================================
PARAMS *dpp-ext-local-params*

==============================================================================
COMPATIBILITY *dpp-ext-local-compatibility*

==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen:noet:
63 changes: 63 additions & 0 deletions doc/dpp-ext-toml.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
*dpp-ext-toml.txt* Toml ext for dpp.vim

Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license

CONTENTS *dpp-ext-toml-contents*

Introduction |dpp-ext-toml-introduction|
Install |dpp-ext-toml-install|
Examples |dpp-ext-toml-examples|
Actions |dpp-ext-toml-actions|
Preview params |dpp-ext-toml-preview-params|
Params |dpp-ext-toml-params|
Compatibility |dpp-ext-toml-compatibility|


==============================================================================
INTRODUCTION *dpp-ext-toml-introduction*

This ext implements toml loading.


==============================================================================
INSTALL *dpp-ext-toml-install*

Please install both "dpp.vim" and "denops.vim".

https://github.com/Shougo/dpp.vim
https://github.com/vim-denops/denops.vim


==============================================================================
EXAMPLES *dpp-ext-toml-examples*
>
const plugins = await args.dpp.extAction(args.denops, "toml", "load", {
path: "$BASE_DIR/dein.toml",
options: {
lazy: true,
},
});
<

==============================================================================
ACTIONS *dpp-ext-toml-actions*

*dpp-ext-toml-action-local*
toml
Returns loaded toml plugins.

params:
{path}: toml file path.
(Required)
{options}: default toml plugin's |dpp-options|.
(Default: {})

==============================================================================
PARAMS *dpp-ext-toml-params*

==============================================================================
COMPATIBILITY *dpp-ext-toml-compatibility*

==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen:noet:
32 changes: 32 additions & 0 deletions doc/dpp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,38 @@ OPTIONS *dpp-options*
------------------------------------------------------------------------------
FUNCTIONS *dpp-functions*

*dpp#get()*
dpp#get([{name}])
Get the plugin options dictionary for {plugin-name}.
If you omit {plugin-name}, dpp will return the plugins
dictionary. The key is the plugin name. The value is the
plugin dictionary.

*dpp#make_state()*
dpp#make_state({base-path}, {config-path})
Save dpp's state in the cache script.
It must be after |DenopsReady|.
{base-path} is where your downloaded plugins will be placed.
{config-path} is TypeScript configuration file to make state.
NOTE: It saves your 'runtimepath' completely, you must not
call it after change 'runtimepath' dynamically.

*dpp#min#load_state()*
dpp#min#load_state({base-path})
Load dpp's state from the cache script, {base-path} is where
your downloaded plugins will be placed.
NOTE: It overwrites your 'runtimepath' completely, you must
not call it after change 'runtimepath' dynamically.
NOTE: The block is skipped if dpp's state is loaded.

It returns 1, if the cache script is old or invalid or not
found.
*dpp#source()*
dpp#source([{name}])
|:source| the plugins specified by {plugins}.
{plugins} is the plugins name list.
If you omit it, dein will source all plugins.
It returns sourced plugins list.

==============================================================================
EXAMPLES *dpp-examples*
Expand Down

0 comments on commit 2f34d18

Please sign in to comment.