summaryrefslogtreecommitdiffstats
path: root/doc/fzf_gitignore.txt
blob: 4d94748ce2d4b73f2199023c0eea02c8e35e09cd (plain) (blame)
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
78
79
80
81
82
83
84
85
if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'gitignore') == -1

*fzf_gitignore.txt* Create useful .gitignore files for your project

Author: Filip Szymański <fszymanski.pl@gmail.com>

==============================================================================
CONTENTS                                              *fzf-gitignore-contents*

  1. Introduction                                |fzf-gitignore-introduction|
  2. Configuration                               |fzf-gitignore-configuration|
  3. Commands                                    |fzf-gitignore-commands|
  4. Mappings                                    |fzf-gitignore-mappings|
  5. License                                     |fzf-gitignore-license|
  6. Bugs                                        |fzf-gitignore-bugs|
  7. Contributing                                |fzf-gitignore-contributing|

==============================================================================
INTRODUCTION                                      *fzf-gitignore-introduction*

fzf[1] interface for creating .gitignore files using the gitignore.io[2] API.

Note: This plugin was inspired by helm-gitignore[3].

==============================================================================
CONFIGURATION                                    *fzf-gitignore-configuration*

                                                     *g:fzf_gitignore_no_maps*
Set this option to disable all key mappings.
>
  let g:fzf_gitignore_no_maps = 1
<
Default: Not defined (number)

                                                         *g:fzf_gitignore_map*
Set this option to change the |<Plug>(fzf-gitignore)| key mapping.
>
  let g:fzf_gitignore_map = '<Leader>i'
<
Default: '<Leader>gi' (string)

==============================================================================
COMMANDS                                              *fzf-gitignore-commands*

                                                               *:FzfGitignore*
Create .gitignore file.

==============================================================================
MAPPINGS                                              *fzf-gitignore-mappings*

 -----------------------------------+----------------------------------------
  Mapping                           | Description                            ~
 -----------------------------------+----------------------------------------
  <Plug>(fzf-gitignore)             | Create .gitignore file
 -----------------------------------+----------------------------------------

==============================================================================
LICENSE                                                *fzf-gitignore-license*

MIT

==============================================================================
BUGS                                                      *fzf-gitignore-bugs*

If you find a bug please create an issue on GitHub.

https://github.com/fszymanski/fzf-gitignore/issues

==============================================================================
CONTRIBUTING                                      *fzf-gitignore-contributing*

Think you can make this plugin better? Awesome. Fork it on GitHub and create
a pull request.

https://github.com/fszymanski/fzf-gitignore

==============================================================================

[1] https://github.com/junegunn/fzf
[2] https://www.gitignore.io/
[3] https://github.com/jupl/helm-gitignore

 vim: tw=78 ts=8 ft=help norl

endif