summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAdam Stankiewicz <sheerun@sher.pl>2020-09-25 00:07:37 +0200
committerAdam Stankiewicz <sheerun@sher.pl>2020-09-25 00:07:37 +0200
commitd6479bbf0baeeedaa183c1f3e11679246ca20138 (patch)
tree0f9db8bc0d5e6e44db0cb78b3a879eb1a7eac08c /doc
parentd53d2189b92ab8150753201e2e2f8cba14b8edc9 (diff)
downloadvim-polyglot-d6479bbf0baeeedaa183c1f3e11679246ca20138.tar.gz
vim-polyglot-d6479bbf0baeeedaa183c1f3e11679246ca20138.zip
Change gitignore provider
Diffstat (limited to 'doc')
-rw-r--r--doc/fzf_gitignore.txt85
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/fzf_gitignore.txt b/doc/fzf_gitignore.txt
new file mode 100644
index 00000000..4d94748c
--- /dev/null
+++ b/doc/fzf_gitignore.txt
@@ -0,0 +1,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