1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-03 01:10:05 +08:00

docs(todomanager): add :h SpaceVim-plugins-todomanager

This commit is contained in:
wsdjeg 2022-04-05 20:17:35 +08:00
parent dae85aaf34
commit 3f99d0c297
3 changed files with 50 additions and 7 deletions

View File

@ -1193,6 +1193,11 @@ let g:spacevim_project_rooter_outermost = 1
" Config the command line prompt for flygrep and denite etc. " Config the command line prompt for flygrep and denite etc.
let g:spacevim_commandline_prompt = '➭' let g:spacevim_commandline_prompt = '➭'
""
" @section todo_labels, options-todo_labels
" @parentsection options
" Option for setting todo labels in current project.
"" ""
" Option for setting todo labels in current project. " Option for setting todo labels in current project.
let g:spacevim_todo_labels = map(['fixme', 'question', 'todo', 'idea'], '"@" . v:val') let g:spacevim_todo_labels = map(['fixme', 'question', 'todo', 'idea'], '"@" . v:val')

View File

@ -6,6 +6,21 @@
" License: GPLv3 " License: GPLv3
"============================================================================= "=============================================================================
""
" @section todo manager, plugins-todomanager
" @parentsection plugins
" The `todomanager` plugin provides todo manager support for SpaceVim.
"
" @subsection Key bindings
" >
" Key binding Description
" SPC a o open todo manager windows
" <
"
" @subsection Configuration
"
" The todo manager labels can be set via @section(options-todo_labels)
let s:JOB = SpaceVim#api#import('job') let s:JOB = SpaceVim#api#import('job')
let s:BUFFER = SpaceVim#api#import('vim#buffer') let s:BUFFER = SpaceVim#api#import('vim#buffer')
let s:SYS = SpaceVim#api#import('system') let s:SYS = SpaceVim#api#import('system')

View File

@ -77,13 +77,14 @@ CONTENTS *SpaceVim-contents*
56. statusline_separator.........|SpaceVim-options-statusline_separator| 56. statusline_separator.........|SpaceVim-options-statusline_separator|
57. statusline_unicode.............|SpaceVim-options-statusline_unicode| 57. statusline_unicode.............|SpaceVim-options-statusline_unicode|
58. terminal_cursor_shape.......|SpaceVim-options-terminal_cursor_shape| 58. terminal_cursor_shape.......|SpaceVim-options-terminal_cursor_shape|
59. vim_help_language...............|SpaceVim-options-vim_help_language| 59. todo_labels...........................|SpaceVim-options-todo_labels|
60. vimcompatible.......................|SpaceVim-options-vimcompatible| 60. vim_help_language...............|SpaceVim-options-vim_help_language|
61. warning_symbol.....................|SpaceVim-options-warning_symbol| 61. vimcompatible.......................|SpaceVim-options-vimcompatible|
62. windisk_encoding.................|SpaceVim-options-windisk_encoding| 62. warning_symbol.....................|SpaceVim-options-warning_symbol|
63. windows_index_type.............|SpaceVim-options-windows_index_type| 63. windisk_encoding.................|SpaceVim-options-windisk_encoding|
64. windows_leader.....................|SpaceVim-options-windows_leader| 64. windows_index_type.............|SpaceVim-options-windows_index_type|
65. windows_smartclose.............|SpaceVim-options-windows_smartclose| 65. windows_leader.....................|SpaceVim-options-windows_leader|
66. windows_smartclose.............|SpaceVim-options-windows_smartclose|
3. Configuration...........................................|SpaceVim-config| 3. Configuration...........................................|SpaceVim-config|
4. Commands..............................................|SpaceVim-commands| 4. Commands..............................................|SpaceVim-commands|
5. Public functions.....................................|SpaceVim-functions| 5. Public functions.....................................|SpaceVim-functions|
@ -232,6 +233,7 @@ CONTENTS *SpaceVim-contents*
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|
3. todo manager...........................|SpaceVim-plugins-todomanager|
9. API........................................................|SpaceVim-api| 9. API........................................................|SpaceVim-api|
1. clock............................................|SpaceVim-api-clock| 1. clock............................................|SpaceVim-api-clock|
2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu| 2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu|
@ -819,6 +821,11 @@ the following to ~/.tmux.conf:
set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q' set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
< <
==============================================================================
TODO_LABELS *SpaceVim-options-todo_labels*
Option for setting todo labels in current project.
============================================================================== ==============================================================================
VIM_HELP_LANGUAGE *SpaceVim-options-vim_help_language* VIM_HELP_LANGUAGE *SpaceVim-options-vim_help_language*
@ -5530,6 +5537,22 @@ KEY BINDINGS
i insert text to background process i insert text to background process
< <
==============================================================================
TODO MANAGER *SpaceVim-plugins-todomanager*
The `todomanager` plugin provides todo manager support for SpaceVim.
KEY BINDINGS
>
Key binding Description
SPC a o open todo manager windows
<
CONFIGURATION
The todo manager labels can be set via |SpaceVim-options-todo_labels|
============================================================================== ==============================================================================
API *SpaceVim-api* API *SpaceVim-api*