Doc: avoid using default keys for custom indices

This commit is contained in:
Marco Hinz 2016-03-11 11:02:29 +01:00
parent 193e0802ec
commit a4908f16e1

View file

@ -192,8 +192,10 @@ the value the path.
Example: Example:
> >
let g:startify_bookmarks = [ {'v': '~/.vimrc'}, '~/.zshrc' ] let g:startify_bookmarks = [ {'c': '~/.vimrc'}, '~/.zshrc' ]
< <
NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*g:startify_files_number* *g:startify_files_number*
> >
@ -417,14 +419,7 @@ If you want numbers to start at 1 instead of 0, you could use this:
let g:startify_custom_indices = map(range(1,100), 'string(v:val)') let g:startify_custom_indices = map(range(1,100), 'string(v:val)')
< <
NOTE: There is no sanitizing going on, so you should know what you're doing! NOTE: There is no sanitizing going on, so you should know what you're doing!
Avoid using keys from |startify-mappings|.
Best practices:
- do not use 'e', 'i' or 'q' (they will be overwritten anyway)
- do not use 'b', 's', 't', 'v' (used for opening several files at once)
- do not use duplicates (previous mappings will be overwritten)
- do not uses empty strings (creates unreachable entries)
- you might want to keep 'j' and 'k' (for navigation)
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*g:startify_custom_header* *g:startify_custom_header*
@ -839,9 +834,8 @@ This is my configuration..
\ ] \ ]
let g:startify_bookmarks = [ let g:startify_bookmarks = [
\ { 'v': '~/.vim/vimrc' }, \ { 'c': '~/.vim/vimrc' },
\ { 't': '/tmp' }, \ '~/golfing',
\ '/data/vim/golfing',
\ ] \ ]
let g:startify_custom_footer = let g:startify_custom_footer =