diff --git a/doc/startify.txt b/doc/startify.txt index c7ab769..890ae99 100644 --- a/doc/startify.txt +++ b/doc/startify.txt @@ -153,12 +153,6 @@ there are more paths to fill in the startify buffer than actual items in the custom list, the rest will be filled up using the default numbering scheme starting from 0. -NOTE: There is no sanitizing going on, so you should know what you do! - -E.g. you don't want to use duplicates. Same for 'e', 'i', 'q'. Actually you -can use them, but they would be overwritten by mappings for creating the empty -buffer and quitting. You may want to keep 'j' and 'k', too. - Example: let g:startify_custom_indices = ['a','s','d','f'] This would result in: @@ -171,6 +165,15 @@ This would result in: [1] /last/recently/used/file6 etc. +NOTE: There is no sanitizing going on, so you should know what you're doing! + +Best practices: + +- do not use 'e', 'i' or 'q' (they will be overwritten anyway) +- 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) + ============-