summaryrefslogtreecommitdiff
path: root/.vim/pack/vendor/start/vim-devicons/doc
diff options
context:
space:
mode:
Diffstat (limited to '.vim/pack/vendor/start/vim-devicons/doc')
-rw-r--r--.vim/pack/vendor/start/vim-devicons/doc/webdevicons.txt1078
1 files changed, 1078 insertions, 0 deletions
diff --git a/.vim/pack/vendor/start/vim-devicons/doc/webdevicons.txt b/.vim/pack/vendor/start/vim-devicons/doc/webdevicons.txt
new file mode 100644
index 0000000..c1f5db1
--- /dev/null
+++ b/.vim/pack/vendor/start/vim-devicons/doc/webdevicons.txt
@@ -0,0 +1,1078 @@
1*devicons*
2
3===============================================================================
4Contents ~
5
6 1. Introduction |devicons-introduction|
7 2. Features |devicons-features|
8 3. Installation |devicons-installation|
9 4. Developers |devicons-developers|
10 5. Troubleshooting |devicons-troubleshooting|
11 6. Contributing |devicons-contributing|
12 1. Code of Conduct [22] |devicons-code-of-conduct-22|
13 2. Contributing Guide [23] |devicons-contributing-guide-23|
14 3. Promotion |devicons-promotion|
15 7. Acknowledgments |devicons-acknowledgments|
16 8. License |devicons-license|
17 9. Detailed Installation |devicons-detailed-installation|
18 1. Step 1 'Nerd Font' |Nerd-Font|
19 2. Step 2 'VimDevIcons Plugin' |VimDevIcons-Plugin|
20 1. Pathogen [38] |devicons-pathogen-38|
21 2. NeoBundle [39] |devicons-neobundle-39|
22 3. Vundle [40] |devicons-vundle-40|
23 4. Manual |devicons-manual|
24 3. Step 3 'Configure Vim' |Configure-Vim|
25 1. Set Encoding |devicons-set-encoding|
26 2. Set Font |devicons-set-font|
27 3. vim-airline |devicons-vim-airline|
28 4. vimrc examples |devicons-vimrc-examples|
29 4. That's it! You're done. |devicons-thats-it-youre-done.|
30 10. Usage |devicons-usage|
31 1. NERDTree |devicons-nerdtree|
32 2. Unite |devicons-unite|
33 3. Denite |devicons-denite|
34 4. Vimfiler |devicons-vimfiler|
35 5. CtrlP |devicons-ctrlp|
36 6. Airline |devicons-airline|
37 7. Startify |devicons-startify|
38 8. Lightline Setup |devicons-lightline-setup|
39 9. Powerline Setup |devicons-powerline-setup|
40 10. Flagship |devicons-flagship|
41 11. Detailed Features |devicons-detailed-features|
42 12. Extra Configuration |devicons-extra-configuration|
43 1. Character Mappings |devicons-character-mappings|
44 2. API |devicons-api|
45 1. Public Methods |devicons-public-methods|
46 2. API Examples |devicons-api-examples|
47 1. Status line |devicons-status-line|
48 2. Simple function call |devicons-simple-function-call|
49 3. Integration with other plugins |devicons-integration-with-other-plugins|
50 1. vim-startify |devicons-vim-startify|
51 13. FAQ |devicons-faq|
52 1. Why isn't it working? How come I don't see any icons? |devicons-why-isnt-it-working-how-come-i-dont-see-any-icons|
53 2. How did you get color matching based on file type in NERDtree? |devicons-how-did-you-get-color-matching-based-on-file-type-in-nerdtree|
54 3. How did you get color matching on just the glyph/icon in NERDtree? |devicons-how-did-you-get-color-matching-on-just-glyph-icon-in-nerdtree|
55 4. How do I solve issues after re-sourcing my |vimrc|?
56 5. Why do I have artifacts after (or instead) of icons? |devicons-why-do-i-have-artifacts-after-of-icons|
57 6. Square brackets around icons |devicons-square-brackets-around-icons|
58 1. from terminal |devicons-from-terminal|
59 7. Do I have to use a patched font such as Nerd Fonts? |devicons-do-i-have-to-use-patched-font-such-as-nerd-fonts|
60 8. Rationale: Why does this exist? How did this start? |devicons-rationale-why-does-this-exist-how-did-this-start|
61 14. References |devicons-references|
62
63===============================================================================
64 *devicons-introduction*
65Introduction ~
66>
67 _ ___ ____ ____
68 | | / (_____ ___ / __ \___ _ __/ _/________ ____ _____
69 | | / / / __ `__ \/ / / / _ | | / // // ___/ __ \/ __ \/ ___/
70 | |/ / / / / / / / /_/ / __| |/ _/ // /__/ /_/ / / / (__ )
71 |___/_/_/ /_/ /_/_____/\___/|___/___/\___/\____/_/ /_/____/
72<
73**VimDevIcons**
74
75Adds Icons to Your Plugins
76
77Supports plugins such as NERDTree [1], vim-airline [2], CtrlP [3], powerline
78[4], denite [5], unite [6], lightline.vim [7], vim-startify [8], vimfiler [9],
79vim-workspace [10] and flagship [11].
80
81See Screenshots [12] for more.
82
83===============================================================================
84 *devicons-features*
85Features ~
86
87- Adds filetype glyphs (icons) to various vim plugins.
88- Supports byte order marker (BOM).
89- Customizable and extendable glyphs settings.
90- Supports a wide range of file type extensions.
91- Supports popular full filenames, like '.gitignore', 'node_modules',
92 '.vimrc'.
93- Works with patched fonts, especially Nerd Fonts [13].
94
95See Detailed Features [14] for more.
96
97See Configuration [15] for a list of configuration and customization options.
98
99===============================================================================
100 *devicons-installation*
101Installation ~
102
1031. Install a Nerd Font compatible font [16] or patch your own [17]. Then set
104 your terminal font (or 'guifont' if you are using GUI version of Vim).
105
1062. Install the Vim plugin with your favorite plugin manager, e.g. vim-plug
107 [18]:
108
109 "vim Plug 'ryanoasis/vim-devicons'"
110
111 Always load the vim-devicons as the very last one.
112
1133. Configure Vim
114
115 'vim set encoding=UTF-8'
116
117 No need to set explicitly under Neovim: always uses UTF-8 as the default
118 encoding.
119
120See Installation [19] for detailed setup instructions
121
122Use ':help devicons' for further configuration.
123
124===============================================================================
125 *devicons-developers*
126Developers ~
127
128See DEVELOPER [20] for how to use the API.
129
130===============================================================================
131 *devicons-troubleshooting*
132Troubleshooting ~
133
134See FAQ [21].
135
136===============================================================================
137 *devicons-contributing*
138Contributing ~
139
140-------------------------------------------------------------------------------
141 *devicons-code-of-conduct-22*
142Code of Conduct [22] ~
143
144This project has adopted a Code of Conduct that we expect project participants
145to adhere to. Check out code of conduct [22] for further details.
146
147-------------------------------------------------------------------------------
148 *devicons-contributing-guide-23*
149Contributing Guide [23] ~
150
151Read our contributing [23] guide to learn about how to send pull requests,
152creating issues properly.
153
154-------------------------------------------------------------------------------
155 *devicons-promotion*
156Promotion ~
157
158You can help us by simply giving a star or voting on vim.org. It will ensure
159continued development going forward.
160
161- Star this repository on GitHub [24].
162- Vote for it on vim.org [25].
163
164===============================================================================
165 *devicons-acknowledgments*
166Acknowledgments ~
167
168Thanks goes to these people for inspiration and helping with sending PRs.
169
170- vim-airline [2]
171- nerdtree [1]
172- nerdtree-git-plugin [26] by @Xuyuanp [27]
173- seti-ui [28] by @jesseweed [29]
174- devicons [30] by @vorillaz [31]
175- development.svg.icons [32] by @benatespina [33]
176- Learn Vimscript the Hard Way [34] book by Steve Losh [35]
177- All contributors [36]
178
179===============================================================================
180 *devicons-license*
181License ~
182
183MIT [37]
184
185===============================================================================
186 *devicons-detailed-installation*
187Detailed Installation ~
188
189-------------------------------------------------------------------------------
190 *Nerd-Font*
191Step 1 'Nerd Font' ~
192
193Get a **Nerd Font!** [16] or patch your own. [17] Without this, things break
194
195-------------------------------------------------------------------------------
196 *VimDevIcons-Plugin*
197Step 2 'VimDevIcons Plugin' ~
198
199**Set VimDevIcons to load _after_ these plugins!**
200
201NERDTree [1] | vim-airline [2] | CtrlP [3] | powerline [4] | Denite [5] | unite
202[6] | lightline.vim [7] | vim-startify [8] | vimfiler [9] | flagship [11]
203
204Choose your favorite plugin manager
205
206-------------------------------------------------------------------------------
207 *devicons-pathogen-38*
208Pathogen [38] ~
209
210- 'git clone https://github.com/ryanoasis/vim-devicons ~/.vim/bundle/vim-
211 devicons'
212
213-------------------------------------------------------------------------------
214 *devicons-neobundle-39*
215NeoBundle [39] ~
216
217- Add to vimrc:
218
219 "vim NeoBundle 'ryanoasis/vim-devicons'" * And install it:
220
221 'vim :so ~/.vimrc :NeoBundleInstall'
222
223-------------------------------------------------------------------------------
224 *devicons-vundle-40*
225Vundle [40] ~
226
227- Add to vimrc:
228
229 "vim Plugin 'ryanoasis/vim-devicons'" * And install it:
230
231 'vim :so ~/.vimrc :PlugInstall'
232
233-------------------------------------------------------------------------------
234 *devicons-manual*
235Manual ~
236
237- copy all of the files into your '~/.vim' directory
238
239-------------------------------------------------------------------------------
240 *Configure-Vim*
241Step 3 'Configure Vim' ~
242
243Add the following in your '.vimrc' or '.gvimrc':
244
245-------------------------------------------------------------------------------
246 *devicons-set-encoding*
247Set Encoding ~
248
249**Set encoding to UTF-8 to show glyphs**
250
251'vim set encoding=utf8'
252
253-------------------------------------------------------------------------------
254 *devicons-set-font*
255Set Font ~
256
257**Set Vim font to a Nerd Font**
258
259Linux 'vim set guifont='
260>
261 set guifont=DroidSansMono\ Nerd\ Font\ 11
262<
263macOS (OS X) and Windows
264>
265 set guifont=:h
266<
267
268>
269 set guifont=DroidSansMono\ Nerd\ Font:h11
270 " or:
271 set guifont=DroidSansMono_Nerd_Font:h11
272<
273**Note:** if you don't set 'guifont' then you'll have to set your terminal's
274font, else things break!
275
276-------------------------------------------------------------------------------
277 *devicons-vim-airline*
278vim-airline ~
279
280**If you use vim-airline you need this:**
281
282'vim let g:airline_powerline_fonts = 1'
283
284-------------------------------------------------------------------------------
285 *devicons-vimrc-examples*
286vimrc examples ~
287
288- Sample Windows vimrc configuration 1 [41]
289- Sample Linux vimrc configuration 1 [42]
290
291-------------------------------------------------------------------------------
292 *devicons-thats-it-youre-done.*
293That's it! You're done. ~
294
295===============================================================================
296 *devicons-usage*
297Usage ~
298
299If you installed and setup things correctly you should now see icons in the
300supported plugins!
301
302**Notes on include order:** _for support of these plugins: NERDTree [1], vim-
303airline [2], CtrlP [3], powerline [4], Denite [5], unite [6], vimfiler [9],
304flagship [11] you **must** configure vim to load those plugins__before_ vim-
305devicons loads. for better nerdtree-git-plugin [26] support, you _should_
306configure vim to load nerdtree-git-plugin **_before_** VimDevIcons loads. * if
307you are lazy loading Denite [5] using the Dein plugin manager, you will need to
308source VimDevIcons before Denite loads.
309
310Lightline Setup and Powerline Setup require some extra setup as shown below:
311
312-------------------------------------------------------------------------------
313 *devicons-nerdtree*
314NERDTree ~
315
316Should work "out of the box", no particular configuration should be needed.
317>
318 " Can be enabled or disabled
319 let g:webdevicons_enable_nerdtree = 1
320<
321
322>
323 " whether or not to show the nerdtree brackets around flags
324 let g:webdevicons_conceal_nerdtree_brackets = 1
325<
326-------------------------------------------------------------------------------
327 *devicons-unite*
328Unite ~
329
330Should work "out of the box", no particular configuration should be needed.
331>
332 " Can be enabled or disabled
333 " adding the custom source to unite
334 let g:webdevicons_enable_unite = 1
335<
336-------------------------------------------------------------------------------
337 *devicons-denite*
338Denite ~
339
340Should work "out of the box", no particular configuration should be needed.
341>
342 " Can be enabled or disabled
343 " Adding the custom source to denite
344 let g:webdevicons_enable_denite = 1
345<
346-------------------------------------------------------------------------------
347 *devicons-vimfiler*
348Vimfiler ~
349
350Should work "out of the box", no particular configuration should be needed.
351>
352 " Can be enabled or disabled
353 " adding the column to vimfiler
354 let g:webdevicons_enable_vimfiler = 1
355<
356-------------------------------------------------------------------------------
357 *devicons-ctrlp*
358CtrlP ~
359
360Should work "out of the box", no particular configuration should be needed.
361>
362 " Can be enabled or disabled
363 " add glyphs to all modes
364 let g:webdevicons_enable_ctrlp = 1
365<
366-------------------------------------------------------------------------------
367 *devicons-airline*
368Airline ~
369
370Should work "out of the box", no particular configuration should be needed.
371>
372 " adding to vim-airline's tabline
373 let g:webdevicons_enable_airline_tabline = 1
374<
375
376>
377 " adding to vim-airline's statusline
378 let g:webdevicons_enable_airline_statusline = 1
379<
380-------------------------------------------------------------------------------
381 *devicons-startify*
382Startify ~
383
384Should work "out of the box", no particular configuration should be needed.
385>
386 " Can be enabled or disabled
387 " adding to vim-startify screen
388 let g:webdevicons_enable_startify = 1
389<
390-------------------------------------------------------------------------------
391 *devicons-lightline-setup*
392Lightline Setup ~
393
394To add the appropriate icon to lightline [7], call the function
395'WebDevIconsGetFileTypeSymbol()' and/or 'WebDevIconsGetFileFormatSymbol()' in
396your '.vimrc'. For example, you could set your sections to:
397>
398 let g:lightline = {
399 \ 'component_function': {
400 \ 'filetype': 'MyFiletype',
401 \ 'fileformat': 'MyFileformat',
402 \ }
403 \ }
404
405 function! MyFiletype()
406 return winwidth(0) > 70 ? (strlen(&filetype) ? &filetype . ' ' . WebDevIconsGetFileTypeSymbol() : 'no ft') : ''
407 endfunction
408
409 function! MyFileformat()
410 return winwidth(0) > 70 ? (&fileformat . ' ' . WebDevIconsGetFileFormatSymbol()) : ''
411 endfunction
412<
413-------------------------------------------------------------------------------
414 *devicons-powerline-setup*
415Powerline Setup ~
416
417- _Note this is for the current Powerline [4] not the deprecated vim-
418 powerline [43]_
419
420To enable for Powerline [4] some |vimrc| and powerline configuration changes
421are needed:
422
423|vimrc| changes (only required if you don't already have powerline setup for
424vim):
425>
426 set rtp+=$HOME/.local/lib/python2.7/site-packages/powerline/bindings/vim/
427
428 " Always show statusline
429 set laststatus=2
430
431 " Use 256 colours (Use this setting only if your terminal supports 256 colours)
432 set t_Co=256
433<
434powerline configuration changes:
435
436file type segment
437>
438 {
439 "function": "vim_devicons.powerline.segments.webdevicons",
440 "priority": 10,
441 "draw_soft_divider": false,
442 "after": " "
443 }
444<
445file format segment
446>
447 {
448 "function": "vim_devicons.powerline.segments.webdevicons_file_format",
449 "draw_soft_divider": false,
450 "exclude_modes": ["nc"],
451 "priority": 90
452 }
453<
454for full example see sample file [44]
455
456-------------------------------------------------------------------------------
457 *devicons-flagship*
458Flagship ~
459
460Should work "out of the box", no particular configuration should be needed.
461>
462 " Can be enabled or disabled
463 " adding to flagship's statusline
464 let g:webdevicons_enable_flagship_statusline = 1
465<
466===============================================================================
467 *devicons-detailed-features*
468Detailed Features ~
469
470- Adds filetype glyphs (icons) to various vim plugins, currently supports:
471
472- NERDTree [1]
473
474 - Using the version hosted on vimscripts [45] in favor of GitHub will
475 lead to a outdated message, and icons will fail to show.
476
477- vim-airline [2] (statusline and tabline)
478
479- CtrlP [3] (All modes now supported)
480
481 - Using the version hosted on vimscripts [46] in favor of GitHub will
482 lead to a outdated message, and icons will fail to show.
483
484- powerline [4] (statusline)
485
486 - see: powerline setup
487
488- Denite [5]
489
490 - Currently supports 'file_rec', 'file_old', 'buffer', and
491 'directory_rec'
492
493- unite [6]
494
495 - Currently supports 'file', 'file_rec', 'buffer', 'file_rec/async', and
496 'file_rec/neovim'
497
498- lightline.vim [7] (statusline)
499
500 - see: lightline setup
501
502- vim-startify [8]
503
504- vimfiler [9]
505
506- flagship [11]
507
508 - Support is **experimental** because the API may be changing [47]
509
510- vim-workspace [10]
511
512- Supports byte order marker (BOM)
513
514- Customizable and extendable glyphs (icons) settings
515
516- ability to override defaults and use your own characters or glyphs
517
518- Supports a wide range of file type extensions by default:
519
520- 'styl, sass, scss, htm, html, slim, ejs, css, less, md, rmd, json, js, jsx,
521 rb, php, py, pyc, pyd, pyo, coffee, mustache, hbs, conf, ini, yml, yaml,
522 bat, jpg, jpeg, bmp, png, gif, twig, cpp, c++, cxx, cc, cp, c, h, hpp, hxx,
523 hs, lhs, lua, java, sh, bash, zsh, ksh, csh, awk, ps1, fish, diff, db, clj,
524 cljs, edn, scala, go, dart, xul, sln, suo, pl, pm, t, rss, f#, fsscript,
525 fsx, fs, fsi, rs, rlib, d, erl, hrl, vim, ai, psd, psb, ts, jl, pp, vue,
526 swift, eex, ex, exs'
527
528- Supports a few full filename matches, by default:
529
530- 'gruntfile.coffee, gruntfile.js, gruntfile.ls, gulpfile.coffee,
531 gulpfile.js, gulpfile.ls, dropbox, .ds_store, .gitconfig, .gitignore,
532 .bashrc, .zshrc, .vimrc, .bashprofile, favicon.ico, license, node_modules,
533 react.jsx, procfile'
534
535- Supports a few library pattern matches, by default:
536
537- 'jquery, angular, backbone, requirejs, materialize, mootools, Vagrantfile'
538
539- Works with patched fonts, especially Nerd Fonts [13]
540
541===============================================================================
542 *devicons-extra-configuration*
543Extra Configuration ~
544
545- These options can be defined in your |vimrc| or 'gvimrc'
546
547- Most options are enabled **'1'** by default but can be disabled with
548 **'0'**
549
550- You _should_**not** need to configure anything, however, the following
551 options are provided for customizing or changing the defaults:
552>
553 " loading the plugin
554 let g:webdevicons_enable = 1
555<
556
557>
558 " adding the flags to NERDTree
559 let g:webdevicons_enable_nerdtree = 1
560<
561
562>
563 " adding the custom source to unite
564 let g:webdevicons_enable_unite = 1
565<
566
567>
568 " adding the column to vimfiler
569 let g:webdevicons_enable_vimfiler = 1
570<
571
572>
573 " adding to vim-airline's tabline
574 let g:webdevicons_enable_airline_tabline = 1
575<
576
577>
578 " adding to vim-airline's statusline
579 let g:webdevicons_enable_airline_statusline = 1
580<
581
582>
583 " ctrlp glyphs
584 let g:webdevicons_enable_ctrlp = 1
585<
586
587>
588 " adding to vim-startify screen
589 let g:webdevicons_enable_startify = 1
590<
591
592>
593 " adding to flagship's statusline
594 let g:webdevicons_enable_flagship_statusline = 1
595<
596
597>
598 " turn on/off file node glyph decorations (not particularly useful)
599 let g:WebDevIconsUnicodeDecorateFileNodes = 1
600<
601
602>
603 " use double-width(1) or single-width(0) glyphs
604 " only manipulates padding, has no effect on terminal or set(guifont) font
605 let g:WebDevIconsUnicodeGlyphDoubleWidth = 1
606<
607
608>
609 " whether or not to show the nerdtree brackets around flags
610 let g:webdevicons_conceal_nerdtree_brackets = 1
611<
612
613>
614 " the amount of space to use after the glyph character (default ' ')
615 let g:WebDevIconsNerdTreeAfterGlyphPadding = ' '
616<
617
618>
619 " Force extra padding in NERDTree so that the filetype icons line up vertically
620 let g:WebDevIconsNerdTreeGitPluginForceVAlign = 1
621<
622
623>
624 " Adding the custom source to denite
625 let g:webdevicons_enable_denite = 1
626
627
628
629 " the amount of space to use after the glyph character in vim-airline
630 tabline(default '')
631 let g:WebDevIconsTabAirLineAfterGlyphPadding = ' '
632
633
634
635 " the amount of space to use before the glyph character in vim-airline
636 tabline(default ' ')
637 let g:WebDevIconsTabAirLineBeforeGlyphPadding = ' '
638<
639-------------------------------------------------------------------------------
640 *devicons-character-mappings*
641Character Mappings ~
642
643- 'ƛ' is used as an example below, substitute for the glyph you **actually**
644 want to use
645>
646 " change the default character when no match found
647 let g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol = 'ƛ'
648<
649
650>
651 " set a byte character marker (BOM) utf-8 symbol when retrieving file encoding
652 " disabled by default with no value
653 let g:WebDevIconsUnicodeByteOrderMarkerDefaultSymbol = ''
654<
655
656>
657 " enable folder/directory glyph flag (disabled by default with 0)
658 let g:WebDevIconsUnicodeDecorateFolderNodes = 1
659<
660
661>
662 " enable open and close folder/directory glyph flags (disabled by default with 0)
663 let g:DevIconsEnableFoldersOpenClose = 1
664<
665
666>
667 " enable pattern matching glyphs on folder/directory (enabled by default with 1)
668 let g:DevIconsEnableFolderPatternMatching = 1
669<
670
671>
672 " enable file extension pattern matching glyphs on folder/directory (disabled by default with 0)
673 let g:DevIconsEnableFolderExtensionPatternMatching = 0
674<
675
676>
677 " disable showing the distribution for unix file encoding (enabled by default with 1)
678 let g:DevIconsEnableDistro = 0
679<
680
681>
682 " enable custom folder/directory glyph exact matching
683 " (enabled by default when g:WebDevIconsUnicodeDecorateFolderNodes is set to 1)
684 let WebDevIconsUnicodeDecorateFolderNodesExactMatches = 1
685<
686
687>
688 " change the default folder/directory glyph/icon
689 let g:WebDevIconsUnicodeDecorateFolderNodesDefaultSymbol = 'ƛ'
690<
691
692>
693 " change the default open folder/directory glyph/icon (default is '')
694 let g:DevIconsDefaultFolderOpenSymbol = 'ƛ'
695<
696
697>
698 " change the default dictionary mappings for file extension matches
699
700 let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols = {} " needed
701 let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols['js'] = 'ƛ'
702<
703
704>
705 " change the default dictionary mappings for exact file node matches
706
707 let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols = {} " needed
708 let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols['MyReallyCoolFile.okay'] = 'ƛ'
709<
710
711>
712 " add or override individual additional filetypes
713
714 let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols = {} " needed
715 let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols['myext'] = 'ƛ'
716<
717
718>
719 " add or override pattern matches for filetypes
720 " these take precedence over the file extensions
721
722 let g:WebDevIconsUnicodeDecorateFileNodesPatternSymbols = {} " needed
723 let g:WebDevIconsUnicodeDecorateFileNodesPatternSymbols['.*jquery.*\.js$'] = 'ƛ'
724<
725specify OS to decide an icon for unix fileformat (_not_ defined by default) -
726this is useful for avoiding unnecessary 'system()' call. see #135 [48] for
727further details.
728>
729 let g:WebDevIconsOS = 'Darwin'
730<
731-------------------------------------------------------------------------------
732 *devicons-api*
733API ~
734>
735 " returns the font character that represents the icon
736 " parameters: a:1 (filename), a:2 (isDirectory)
737 " both parameters optional
738 " by default without parameters uses buffer name
739 WebDevIconsGetFileTypeSymbol(...)
740
741 " returns the font character that represents
742 " the file format as an icon (windows, linux, mac)
743 WebDevIconsGetFileFormatSymbol()
744<
745-------------------------------------------------------------------------------
746 *devicons-public-methods*
747Public Methods ~
748>
749 " Returns the current version of the plugin
750 webdevicons#version()
751<
752
753>
754 " Calls webdevicons#softRefresh()
755 " basically a backwards compatibility convenience
756 webdevicons#refresh()
757<
758
759>
760 " Does a 'hard' refresh of NERDTree
761 " resets vim-devicons syntax and closes and reopens NERDTree
762 webdevicons#hardRefresh()
763<
764
765>
766 " Does a 'soft' refresh of NERDTree
767 " resets vim-devicons syntax and toggles NERDTree to the same state
768 webdevicons#softRefresh()
769<
770-------------------------------------------------------------------------------
771 *devicons-api-examples*
772API Examples ~
773
774-------------------------------------------------------------------------------
775 *devicons-status-line*
776Status line ~
777
778Custom vim status line (not relying on vim-airline or lightline):
779>
780 set statusline=%f\ %{WebDevIconsGetFileTypeSymbol()}\ %h%w%m%r\ %=%(%l,%c%V\ %Y\ %=\ %P%)
781<
782-------------------------------------------------------------------------------
783 *devicons-simple-function-call*
784Simple function call ~
785>
786 echo WebDevIconsGetFileFormatSymbol()
787<
788-------------------------------------------------------------------------------
789 *devicons-integration-with-other-plugins*
790Integration with other plugins ~
791
792-------------------------------------------------------------------------------
793 *devicons-vim-startify*
794vim-startify ~
795>
796 let entry_format = "' ['. index .']'. repeat(' ', (3 - strlen(index)))"
797
798 if exists('*WebDevIconsGetFileTypeSymbol') " support for vim-devicons
799 let entry_format .= ". WebDevIconsGetFileTypeSymbol(entry_path) .' '. entry_path"
800 else
801 let entry_format .= '. entry_path'
802 endif
803<
804===============================================================================
805 *devicons-faq*
806FAQ ~
807
808**Table of Contents:**
809
810**It's not working at all:**
811
812- **Why isn't it working? How come I don't see any icons?**
813
814**Syntax or color highlighting:**
815
816- **How did you get color matching based on file type in NERDtree?**
817- **How did you get color matching on just the glyph/icon in NERDtree?**
818
819**Re-sourcing |vimrc|:**
820
821- **How do I solve issues after re-sourcing my |vimrc|?**
822
823**Weird artifacts after/on the glyphs:**
824
825- **Why do I have artifacts after (or instead) of icons?**
826- **Square brackets around icons?**
827
828**Fonts:**
829
830- **Do I have to use a patched font such as Nerd Fonts?**
831
832**Why does this exist? How did this start?**
833
834-------------------------------------------------------------------------------
835 *devicons-why-isnt-it-working-how-come-i-dont-see-any-icons*
836Why isn't it working? How come I don't see any icons? ~
837
838- Are you using the patched font provided in the separate repo (Nerd Fonts
839 [13]) or are you patching your own?
840
841- _NOTE:_ if running vim and no font set it will default to the terminal font
842 that is set
843
844- check what the vim/gvim font is set to, from ex mode:
845
846 'vim :set guifont?'
847
848- check if the plugin is loaded (should give '1'), from ex mode:
849
850 'vim :echo loaded_webdevicons'
851
852- check if the plugin is enabled (should give '1'), from ex mode:
853
854 'vim :echo g:webdevicons_enable'
855
856- check if the plugin is enabled for NERDTree (should give '1'), from ex
857 mode:
858
859 - this should _NOT_ need to be set under normal circumstances
860
861 'vim :echo g:webdevicons_enable_nerdtree'
862
863- check if you are able to see the characters, from ex mode:
864
865 'vim :echo g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol'
866
867- if all this looks correct you may try this to see if any files show flags
868
869 - last resort, see if you can even set the default symbol and have it
870 display anywhere (NERDTree, vim-airline's statusline, vim-airlines's
871 tabline), from ex mode:
872
873 "vim :let g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol='x'"
874
875-------------------------------------------------------------------------------
876 *devicons-how-did-you-get-color-matching-based-on-file-type-in-nerdtree*
877How did you get color matching based on file type in NERDtree? ~
878
879- You can either use this additional plugin: vim-nerdtree-syntax-highlight
880 [49] created by @tiagofumo [50]
881
882- Or you can use my current settings from:
883 https://github.com/scrooloose/nerdtree/issues/201#issuecomment-9954740
884
885 ```vim " NERDTress File highlighting function!
886 NERDTreeHighlightFile(extension, fg, bg, guifg, guibg) exec 'autocmd
887 FileType nerdtree highlight ' . a:extension .' ctermbg='. a:bg .'
888 ctermfg='. a:fg .' guibg='. a:guibg .' guifg='. a:guifg exec 'autocmd
889 FileType nerdtree syn match ' . a:extension .' #^\s+.*'. a:extension .'$#'
890 endfunction
891
892 call NERDTreeHighlightFile('jade', 'green', 'none', 'green', '#151515')
893 call NERDTreeHighlightFile('ini', 'yellow', 'none', 'yellow', '#151515')
894 call NERDTreeHighlightFile('md', 'blue', 'none', '#3366FF', '#151515') call
895 NERDTreeHighlightFile('yml', 'yellow', 'none', 'yellow', '#151515') call
896 NERDTreeHighlightFile('config', 'yellow', 'none', 'yellow', '#151515') call
897 NERDTreeHighlightFile('conf', 'yellow', 'none', 'yellow', '#151515') call
898 NERDTreeHighlightFile('json', 'yellow', 'none', 'yellow', '#151515') call
899 NERDTreeHighlightFile('html', 'yellow', 'none', 'yellow', '#151515') call
900 NERDTreeHighlightFile('styl', 'cyan', 'none', 'cyan', '#151515') call
901 NERDTreeHighlightFile('css', 'cyan', 'none', 'cyan', '#151515') call
902 NERDTreeHighlightFile('coffee', 'Red', 'none', 'red', '#151515') call
903 NERDTreeHighlightFile('js', 'Red', 'none', '#ffa500', '#151515') call
904 NERDTreeHighlightFile('php', 'Magenta', 'none', '#ff00ff', '#151515') call
905 NERDTreeHighlightFile('ds_store', 'Gray', 'none', '#686868', '#151515')
906 call NERDTreeHighlightFile('gitconfig', 'Gray', 'none', '#686868',
907 '#151515') call NERDTreeHighlightFile('gitignore', 'Gray', 'none',
908 '#686868', '#151515') call NERDTreeHighlightFile('bashrc', 'Gray', 'none',
909 '#686868', '#151515') call NERDTreeHighlightFile('bashprofile', 'Gray',
910 'none', '#686868', '#151515') 'Note: If the colors still are not
911 highlighting, try invoking such as:' autocmd VimEnter * call
912 NERDTreeHighlightFile('jade', 'green', 'none', 'green', '#151515') ``` per:
913 https://github.com/ryanoasis/vim-devicons/issues/49#issuecomment-101753558
914
915-------------------------------------------------------------------------------
916 *devicons-how-did-you-get-color-matching-on-just-glyph-icon-in-nerdtree*
917How did you get color matching on just the glyph/icon in NERDtree? ~
918
919- You can add something like this to your |vimrc|
920
921 ```vim " NERDTress File highlighting only the glyph/icon " test highlight
922 just the glyph (icons) in nerdtree: autocmd filetype nerdtree highlight
923 haskell_icon ctermbg=none ctermfg=Red guifg=#ffa500 autocmd filetype
924 nerdtree highlight html_icon ctermbg=none ctermfg=Red guifg=#ffa500 autocmd
925 filetype nerdtree highlight go_icon ctermbg=none ctermfg=Red guifg=#ffa500
926
927 autocmd filetype nerdtree syn match haskell_icon ##
928 containedin=NERDTreeFile " if you are using another syn highlight for a
929 given line (e.g. " NERDTreeHighlightFile) need to give that name in the
930 'containedin' for this " other highlight to work with it autocmd filetype
931 nerdtree syn match html_icon ## containedin=NERDTreeFile,html autocmd
932 filetype nerdtree syn match go_icon ## containedin=NERDTreeFile ```
933
934-------------------------------------------------------------------------------
935How do I solve issues after re-sourcing my *vimrc*?
936
937- Try adding this to the bottom of your |vimrc|
938
939 'vim if exists("g:loaded_webdevicons") call webdevicons#refresh() endif'
940
941-------------------------------------------------------------------------------
942 *devicons-why-do-i-have-artifacts-after-of-icons*
943Why do I have artifacts after (or instead) of icons? ~
944
945- Dots after icons in NERDTree (on GVim), try:
946
947'vim autocmd FileType nerdtree setlocal nolist'
948
949source: Issue #110 [51]
950
951- Newly created files in NERDTree are slow to show the glyph (icon)
952- check your current setting of ':updatetime?'
953- try setting 'updatetime' in your |vimrc| to a lower value like '250', for
954 more info see: Issue #153 [52]
955
956-------------------------------------------------------------------------------
957 *devicons-square-brackets-around-icons*
958Square brackets around icons ~
959
960- By default if your Vim supports conceal you should not see these, debug
961 steps:
962
963 - Check if the plugin feature is set (should be '1'):
964
965 'vim echo g:webdevicons_conceal_nerdtree_brackets'
966
967 - Check that your vim was compiled with the 'conceal' feature (should be
968 '+conceal'):
969
970 ```shell
971
972-------------------------------------------------------------------------------
973 *devicons-from-terminal*
974 from terminal ~
975
976 vim --version | grep conceal ```
977
978 - Check the 'conceallevel' (should be '3'):
979
980 'vim set conceallevel?'
981
982-------------------------------------------------------------------------------
983 *devicons-do-i-have-to-use-patched-font-such-as-nerd-fonts*
984Do I have to use a patched font such as Nerd Fonts? ~
985
986VimDevIcons was desired to work with Nerd Fonts [13], however you do _not_ have
987to use a patched font or even Nerd Fonts specified glyphs. You have 2 main
988options:
989
990fontconfig fallback
991
9921. Install the NERD Font symbol fonts:
993
9942. Symbols Nerd Font:style=1000-em [53]
995
9963. Symbols Nerd Font:style=2048-em [54]
997
9984. Install 10-nerd-font-symbols.conf [55] for Fontconfig
999
10005. for additional information see: Issue #124 [56] and [Nerd Fonts
1001 'fontconfig']
1002
1003Use your own glyph codepoints
1004
1005- specify your own glyphs and/or use your own font (see: Character Mappings
1006 [57])
1007
1008-------------------------------------------------------------------------------
1009 *devicons-rationale-why-does-this-exist-how-did-this-start*
1010Rationale: Why does this exist? How did this start? ~
1011
1012After seeing the awesome theme for Atom (seti-ui) and the awesome plugins work
1013done for NERDTree and vim-airline and wanting something like this for Vim I
1014decided to create my first plugin.
1015
1016===============================================================================
1017 *devicons-references*
1018References ~
1019
1020[1] https://github.com/scrooloose/nerdtree
1021[2] https://github.com/vim-airline/vim-airline
1022[3] https://github.com/ctrlpvim/ctrlp.vim
1023[4] https://github.com/powerline/powerline
1024[5] https://github.com/Shougo/denite.nvim
1025[6] https://github.com/Shougo/unite.vim
1026[7] https://github.com/itchyny/lightline.vim
1027[8] https://github.com/mhinz/vim-startify
1028[9] https://github.com/Shougo/vimfiler.vim
1029[10] https://github.com/bagrat/vim-workspace
1030[11] https://github.com/tpope/vim-flagship
1031[12] https://github.com/ryanoasis/vim-devicons/wiki/screenshots
1032[13] https://github.com/ryanoasis/nerd-fonts
1033[14] https://github.com/ryanoasis/vim-devicons/wiki/Detailed-Features
1034[15] https://github.com/ryanoasis/vim-devicons/wiki/Extra-Configuration
1035[16] https://github.com/ryanoasis/nerd-fonts#font-installation
1036[17] https://github.com/ryanoasis/nerd-fonts#font-patcher
1037[18] https://github.com/junegunn/vim-plug
1038[19] https://github.com/ryanoasis/vim-devicons/wiki/Installation
1039[20] DEVELOPER.md
1040[21] https://github.com/ryanoasis/vim-devicons/wiki/FAQ-&-Troubleshooting
1041[22] CODE_OF_CONDUCT.md
1042[23] CONTRIBUTING.md
1043[24] https://github.com/ryanoasis/vim-devicons
1044[25] http://www.vim.org/scripts/script.php?script_id=5114
1045[26] https://github.com/Xuyuanp/nerdtree-git-plugin
1046[27] https://github.com/Xuyuanp
1047[28] https://atom.io/themes/seti-ui
1048[29] https://github.com/jesseweed
1049[30] http://vorillaz.github.io/devicons
1050[31] https://github.com/vorillaz
1051[32] https://github.com/benatespina/development.svg.icons
1052[33] https://github.com/benatespina
1053[34] http://learnvimscriptthehardway.stevelosh.com/
1054[35] http://stevelosh.com/
1055[36] https://github.com/ryanoasis/vim-devicons/graphs/contributors
1056[37] LICENSE
1057[38] https://github.com/tpope/vim-pathogen
1058[39] https://github.com/Shougo/neobundle.vim
1059[40] https://github.com/gmarik/vundle
1060[41] https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.10.x/.vimrc-windows-1
1061[42] https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.10.x/.vimrc-linux-1
1062[43] https://github.com/Lokaltog/vim-powerline
1063[44] https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.10.x/powerline/themes/vim/default.json
1064[45] http://www.vim.org/scripts/script.php?script_id=1658
1065[46] http://www.vim.org/scripts/script.php?script_id=3736
1066[47] https://github.com/tpope/vim-flagship/issues/6#issuecomment-116121220
1067[48] https://github.com/ryanoasis/vim-devicons/pull/135
1068[49] https://github.com/tiagofumo/vim-nerdtree-syntax-highlight
1069[50] https://github.com/tiagofumo
1070[51] https://github.com/ryanoasis/vim-devicons/issues/110#issue-103801335
1071[52] https://github.com/ryanoasis/vim-devicons/issues/153
1072[53] https://github.com/ryanoasis/nerd-fonts/blob/master/src/glyphs/Symbols-1000-em%20Nerd%20Font%20Complete.ttf
1073[54] https://github.com/ryanoasis/nerd-fonts/blob/master/src/glyphs/Symbols-2048-em%20Nerd%20Font%20Complete.ttf
1074[55] https://github.com/ryanoasis/nerd-fonts/blob/master/10-nerd-font-symbols.conf
1075[56] https://github.com/ryanoasis/vim-devicons/issues/124
1076[57] https://github.com/ryanoasis/vim-devicons#character-mappings
1077
1078vim: ft=help