vim-essentials/doc/essentials.txt at master · XD-Builder/vim-essentials · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
*essentials.txt* essential commands for everyday editing

	#######
	#        ####   ####  ###### #    # ##### #   ##   #       ####
	#       #      #      #      ##   #   #   #  #  #  #      #
	#####    ####   ####  #####  # #  #   #   # #    # #       ####
	#            #      # #      #  # #   #   # ###### #           #
	#       #    # #    # #      #   ##   #   # #    # #      #    #
	#######  ####   ####  ###### #    #   #   # #    # ######  ####

==============================================================================
Contents                                                    *essentials-content*

    1. About	    	    |essentials-introduction| |essentials-naming-convention|
    2. Usage         	  |essentials-usage|
    3. Configuration    |essentials-configuration|
    4. Customization    |essentials-customization|
    5. Contributing     |essentials-contributing|
    6. Credits          |essentials-credits|
    7. License          |essentials-license|


==============================================================================
1. About					                                     *essentials-introduction*

Vim-essentials provides essential functionalities inside vim editor.

                                                   *essential-naming-convention*
Naming conventions for autoload folder:
Functions with first letter uppercase is to be exported and lowercase to
be used internally.

==============================================================================
2. Usage						                                          *essentials-usage*

This section explains all available commands provided by essentials and
their usage.


						                                 *EssentialsRemoveWhiteSpace-Usage*

:EssentialsRemoveWhiteSpace
                                Remove all white spaces in the current file.
                                It can be run in visual mode and normal mode

						                                    *EssentialsStackOverflow-Usage*

:EssentialsStackOverflow
                                Makes an call to StackExchange for
                                Stackoverflow questions and answers and put
                                the response in a buffer window with custom
                                format and <space> to fold or unfold

						                                           *EssentialsGoogle-Usage*
:EssentialsGoogle
                                Search word under cursor in normal mode or
                                word under selection in visual mode in a new
                                browser tab.

						                                          *EssentialsGooglef-Usage*
:EssentialsGooglef
                                Search word under cursor in normal mode or
                                word under selection in visual mode prefixed
                                with its file type in a new browser tab.

==============================================================================
3. Configuration				      *essentials-configuration*

 					                                 *EssentialsRemoveWhiteSpace-Config*

Set file types to ignore white space highlight. Default to []
>
	let g:essentials_remove_whitespace_ignore_filetypes = ['text', 'markdown']
<


vim:tw=78:ts=2:et:sts=2:sw=2:ft=help