Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-03-11 08:55:43 +08:00
Code Issues Projects Releases Wiki Activity

docs(alternate): add :h SpaceVim-usage-alternate-file

Browse Source
This commit is contained in:
wsdjeg 2022-04-12 14:45:23 +08:00
parent 6b354194c3
commit 2c385518c0
2 changed files with 46 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
autoload/SpaceVim.vim
View File

@ -1898,7 +1898,24 @@ endfunction
" "
" The footer is optional and is used to reference issue tracker IDs. " The footer is optional and is used to reference issue tracker IDs.
""
" @section alternate file, usage-alternate-file
" @parentsection usage
" SpaceVim provides a built-in alternate file manager, the command is `:A`.
"
" To use this feature, you can create a `.project_alt.json` file in the root
" of your project. for example:
" >
" {
" "autoload/SpaceVim/layers/lang/*.vim" :
" {
" "doc" : "docs/layers/lang/{}.md"
" },
" }
" <
" after adding this configuration, when edit the source file
" `autoload/SpaceVim/layers/lang/java.vim`,
" you can use `:A doc` switch to `docs/layers/lang/java.md`
"" ""
" @section FAQ, faq " @section FAQ, faq

36
doc/SpaceVim.txt
View File

@ -225,14 +225,15 @@ CONTENTS *SpaceVim-contents*
131. ui.............................................|SpaceVim-layers-ui| 131. ui.............................................|SpaceVim-layers-ui|
132. unite.......................................|SpaceVim-layers-unite| 132. unite.......................................|SpaceVim-layers-unite|
7. Usage....................................................|SpaceVim-usage| 7. Usage....................................................|SpaceVim-usage|
1. buffers-and-files..................|SpaceVim-usage-buffers-and-files| 1. alternate file........................|SpaceVim-usage-alternate-file|
2. command-line-mode..................|SpaceVim-usage-command-line-mode| 2. buffers-and-files..................|SpaceVim-usage-buffers-and-files|
3. custom_plugins........................|SpaceVim-usage-custom_plugins| 3. command-line-mode..................|SpaceVim-usage-command-line-mode|
4. repl............................................|SpaceVim-usage-repl| 4. custom_plugins........................|SpaceVim-usage-custom_plugins|
5. search-and-replace................|SpaceVim-usage-search-and-replace| 5. repl............................................|SpaceVim-usage-repl|
6. tasks..........................................|SpaceVim-usage-tasks| 6. search-and-replace................|SpaceVim-usage-search-and-replace|
7. undo-tree...................................|SpaceVim-usage-undotree| 7. tasks..........................................|SpaceVim-usage-tasks|
8. windows-and-tabs....................|SpaceVim-usage-windows-and-tabs| 8. undo-tree...................................|SpaceVim-usage-undotree|
9. windows-and-tabs....................|SpaceVim-usage-windows-and-tabs|
8. Plugins................................................|SpaceVim-plugins| 8. Plugins................................................|SpaceVim-plugins|
1. iedit........................................|SpaceVim-plugins-iedit| 1. iedit........................................|SpaceVim-plugins-iedit|
2. runner......................................|SpaceVim-plugins-runner| 2. runner......................................|SpaceVim-plugins-runner|
@ -5381,6 +5382,25 @@ USAGE *SpaceVim-usage*
General guide for using SpaceVim. Including layer configuration, bootstrap General guide for using SpaceVim. Including layer configuration, bootstrap
function. function.
==============================================================================
ALTERNATE FILE *SpaceVim-usage-alternate-file*
SpaceVim provides a built-in alternate file manager, the command is `:A`.
To use this feature, you can create a `.project_alt.json` file in the root of
your project. for example:
>
{
"autoload/SpaceVim/layers/lang/*.vim" :
{
"doc" : "docs/layers/lang/{}.md"
},
}
<
after adding this configuration, when edit the source file
`autoload/SpaceVim/layers/lang/java.vim`, you can use `:A doc` switch to
`docs/layers/lang/java.md`
============================================================================== ==============================================================================
BUFFERS-AND-FILES *SpaceVim-usage-buffers-and-files* BUFFERS-AND-FILES *SpaceVim-usage-buffers-and-files*