Skip to content

Commit 447969e

Browse files
committed
Updates vim doc for v0.8.5 release
1 parent bddbff2 commit 447969e

1 file changed

Lines changed: 54 additions & 54 deletions

File tree

doc/webdevicons.txt

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Contents ~
1717
3. Vundle [28] |readme-vundle-28|
1818
4. Manual |readme-manual|
1919
3. Step 3 'Configure Vim' |Configure-Vim|
20-
1. Set VimDevIcons to load _before_ these plugins! |readme-set-vimdevicons-to-load-_before_-these-plugins|
20+
1. Set VimDevIcons to load _after_ these plugins! |readme-set-vimdevicons-to-load-_after_-these-plugins|
2121
2. Set encoding to UTF-8 to show glyphs |readme-set-encoding-to-utf-8-to-show-glyphs|
2222
3. Set Vim font to a Nerd Font |readme-set-vim-font-to-nerd-font|
2323
4. If you use vim-airline you need this |readme-if-you-use-vim-airline-you-need-this|
2424
5. vimrc examples |readme-vimrc-examples|
25-
4. That's it! You're done. |readme-thats-it-youre-done.|
25+
4. That's it! You're done. |readme-thats-it-youre-done.|
2626
5. Usage |readme-usage|
2727
1. Lightline Setup |readme-lightline-setup|
2828
2. Powerline Setup |readme-powerline-setup|
@@ -181,8 +181,8 @@ Step 3 'Configure Vim' ~
181181
Add the following in your '.vimrc' or '.gvimrc':
182182

183183
-------------------------------------------------------------------------------
184-
*readme-set-vimdevicons-to-load-_before_-these-plugins*
185-
Set VimDevIcons to load _before_ these plugins! ~
184+
*readme-set-vimdevicons-to-load-_after_-these-plugins*
185+
Set VimDevIcons to load _after_ these plugins! ~
186186

187187
NERDTree [8] | vim-airline [9] | CtrlP [29] | powerline [11] | unite [12] |
188188
lightline.vim [13] | vim-startify [14] | vimfiler [15] | flagship [16]
@@ -227,7 +227,7 @@ vimrc examples ~
227227

228228
-------------------------------------------------------------------------------
229229
*readme-thats-it-youre-done.*
230-
That's it! You're done. ~
230+
That's it! You're done. ~
231231

232232
-------------------------------------------------------------------------------
233233
*readme-usage*
@@ -258,11 +258,11 @@ your '.vimrc'. For example, you could set your sections to:
258258
\ 'fileformat': 'MyFileformat',
259259
\ }
260260
\ }
261-
261+
262262
function! MyFiletype()
263263
return winwidth(0) > 70 ? (strlen(&filetype) ? &filetype . ' ' . WebDevIconsGetFileTypeSymbol() : 'no ft') : ''
264264
endfunction
265-
265+
266266
function! MyFileformat()
267267
return winwidth(0) > 70 ? (&fileformat . ' ' . WebDevIconsGetFileFormatSymbol()) : ''
268268
endfunction
@@ -281,10 +281,10 @@ are needed:
281281
vim):
282282
>
283283
set rtp+=$HOME/.local/lib/python2.7/site-packages/powerline/bindings/vim/
284-
284+
285285
" Always show statusline
286286
set laststatus=2
287-
287+
288288
" Use 256 colours (Use this setting only if your terminal supports 256 colours)
289289
set t_Co=256
290290
<
@@ -317,10 +317,7 @@ Detailed Features ~
317317
- Adds filetype glyphs (icons) to various vim plugins, currently supports:
318318
- NERDTree [8]
319319
- vim-airline [9] (statusline and tabline)
320-
- CtrlP [10]
321-
322-
- Currently only MRU file mode supported
323-
320+
- CtrlP [10] (All modes now supported)
324321
- powerline [11] (statusline)
325322

326323
- see: powerline setup
@@ -370,42 +367,42 @@ Extra Configuration ~
370367
- You _should_**not** need to configure anything, however, the following
371368
options are provided for customizing or changing the defaults:
372369
>
373-
" loading the plugin
370+
" loading the plugin
374371
let g:webdevicons_enable = 1
375372
<
376373

377374
>
378-
" adding the flags to NERDTree
375+
" adding the flags to NERDTree
379376
let g:webdevicons_enable_nerdtree = 1
380377
<
381378

382379
>
383-
" adding the custom source to unite
380+
" adding the custom source to unite
384381
let g:webdevicons_enable_unite = 1
385382
<
386383

387384
>
388-
" adding the column to vimfiler
385+
" adding the column to vimfiler
389386
let g:webdevicons_enable_vimfiler = 1
390387
<
391388

392389
>
393-
" adding to vim-airline's tabline
390+
" adding to vim-airline's tabline
394391
let g:webdevicons_enable_airline_tabline = 1
395392
<
396393

397394
>
398-
" adding to vim-airline's statusline
395+
" adding to vim-airline's statusline
399396
let g:webdevicons_enable_airline_statusline = 1
400397
<
401398

402399
>
403-
" ctrlp MRU file mode glyphs
400+
" ctrlp glyphs
404401
let g:webdevicons_enable_ctrlp = 1
405402
<
406403

407404
>
408-
" adding to flagship's statusline
405+
" adding to flagship's statusline
409406
let g:webdevicons_enable_flagship_statusline = 1
410407
<
411408

@@ -415,13 +412,13 @@ Extra Configuration ~
415412
<
416413

417414
>
418-
" use double-width(1) or single-width(0) glyphs
415+
" use double-width(1) or single-width(0) glyphs
419416
" only manipulates padding, has no effect on terminal or set(guifont) font
420417
let g:WebDevIconsUnicodeGlyphDoubleWidth = 1
421418
<
422419

423420
>
424-
" whether or not to show the nerdtree brackets around flags
421+
" whether or not to show the nerdtree brackets around flags
425422
let g:webdevicons_conceal_nerdtree_brackets = 1
426423
<
427424

@@ -431,7 +428,7 @@ Extra Configuration ~
431428
<
432429

433430
>
434-
" Force extra padding in NERDTree so that the filetype icons line up vertically
431+
" Force extra padding in NERDTree so that the filetype icons line up vertically
435432
let g:WebDevIconsNerdTreeGitPluginForceVAlign = 1
436433
<
437434
-------------------------------------------------------------------------------
@@ -466,7 +463,7 @@ Character Mappings ~
466463
<
467464

468465
>
469-
" enable custom folder/directory glyph exact matching
466+
" enable custom folder/directory glyph exact matching
470467
" (enabled by default when g:WebDevIconsUnicodeDecorateFolderNodes is set to 1)
471468
let WebDevIconsUnicodeDecorateFolderNodesExactMatches = 1
472469
<
@@ -483,29 +480,29 @@ Character Mappings ~
483480

484481
>
485482
" change the default dictionary mappings for file extension matches
486-
483+
487484
let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols = {} " needed
488485
let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols['js'] = 'ƛ'
489486
<
490487

491488
>
492489
" change the default dictionary mappings for exact file node matches
493-
490+
494491
let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols = {} " needed
495492
let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols['MyReallyCoolFile.okay'] = 'ƛ'
496493
<
497494

498495
>
499496
" add or override individual additional filetypes
500-
497+
501498
let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols = {} " needed
502499
let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols['myext'] = 'ƛ'
503500
<
504501

505502
>
506503
" add or override pattern matches for filetypes
507504
" these take precedence over the file extensions
508-
505+
509506
let g:WebDevIconsUnicodeDecorateFileNodesPatternSymbols = {} " needed
510507
let g:WebDevIconsUnicodeDecorateFileNodesPatternSymbols['.*jquery.*\.js$'] = 'ƛ'
511508
<
@@ -553,7 +550,7 @@ API ~
553550
" both parameters optional
554551
" by default without parameters uses buffer name
555552
WebDevIconsGetFileTypeSymbol(...)
556-
553+
557554
" returns the font character that represents
558555
" the file format as an icon (windows, linux, mac)
559556
WebDevIconsGetFileFormatSymbol()
@@ -563,7 +560,7 @@ API ~
563560
API Examples ~
564561
>
565562
let entry_format = "' ['. index .']'. repeat(' ', (3 - strlen(index)))"
566-
563+
567564
if exists('*WebDevIconsGetFileTypeSymbol') " support for vim-devicons
568565
let entry_format .= ". WebDevIconsGetFileTypeSymbol(entry_path) .' '. entry_path"
569566
else
@@ -579,7 +576,8 @@ source: vim-startify [14]
579576
Todo ~
580577

581578
- [ ] more filetypes to support
582-
- [ ] customize filetype icon colors
579+
- [ ] customize filetype icon colors [37] (for a current solution see:
580+
tiagofumo/vim-nerdtree-syntax-highlight [38])
583581
- [ ] more customization options in general
584582
- [ ] more specific FAQ and Troubleshooting help
585583

@@ -593,29 +591,29 @@ See LICENSE
593591
*readme-faq-troubleshooting*
594592
FAQ / Troubleshooting ~
595593

596-
See FAQ [37]
594+
See FAQ [39]
597595

598596
-------------------------------------------------------------------------------
599597
*readme-screenshots*
600598
Screenshots ~
601599

602-
See Screenshots [38]
600+
See Screenshots [40]
603601

604602
-------------------------------------------------------------------------------
605603
*readme-contributing*
606604
Contributing ~
607605

608606
Best ways to contribute _Star it on GitHub - if you use it and like it please
609-
at least star it :)_ Promote _Open issues/tickets [39]_ Submit fixes and/or
607+
at least star it :)_ Promote _Open issues/tickets [41]_ Submit fixes and/or
610608
improvements with Pull Requests
611609

612610
-------------------------------------------------------------------------------
613611
*readme-promotion*
614612
Promotion ~
615613

616614
Like the project? Please support to ensure continued development going forward:
617-
_Star this repo on GitHub [40]_ Follow the repo on GitHub [40] _Vote for it on
618-
vim.org [41]_ Follow me * Twitter [42] * GitHub [43]
615+
_Star this repo on GitHub [42]_ Follow the repo on GitHub [42] _Vote for it on
616+
vim.org [43]_ Follow me * Twitter [44] * GitHub [45]
619617

620618
-------------------------------------------------------------------------------
621619
*readme-source-code*
@@ -641,11 +639,11 @@ Inspiration and special thanks ~
641639
- vim-airline [9]
642640
- nerdtree [8]
643641
- nerdtree-git-plugin [32]
644-
- seti-ui [44]
645-
- devicons by Theodore Vorillas [45]
646-
- benatespina development.svg.icons [46]
647-
- Steve Losh [47]
648-
- Also thanks to the many contributors [48]
642+
- seti-ui [46]
643+
- devicons by Theodore Vorillas [47]
644+
- benatespina development.svg.icons [48]
645+
- Steve Losh [49]
646+
- Also thanks to the many contributors [50]
649647

650648
-------------------------------------------------------------------------------
651649
License ~
@@ -692,17 +690,19 @@ References ~
692690
[34] https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.8.x/powerline/themes/vim/default.json
693691
[35] https://github.com/tpope/vim-flagship/issues/6#issuecomment-116121220
694692
[36] https://github.com/ryanoasis/vim-devicons/pull/135
695-
[37] https://github.com/ryanoasis/vim-devicons/wiki/FAQ
696-
[38] https://github.com/ryanoasis/vim-devicons/wiki/Screenshots
697-
[39] https://github.com/ryanoasis/vim-devicons/issues
698-
[40] https://github.com/ryanoasis/vim-devicons
699-
[41] http://www.vim.org/scripts/script.php?script_id=5114
700-
[42] http://twitter.com/ryanlmcintyre
701-
[43] https://github.com/ryanoasis
702-
[44] https://atom.io/themes/seti-ui
703-
[45] http://vorillaz.github.io/devicons
704-
[46] https://github.com/benatespina/development.svg.icons
705-
[47] http://learnvimscriptthehardway.stevelosh.com/
706-
[48] https://github.com/ryanoasis/vim-devicons/graphs/contributors
693+
[37] https://github.com/ryanoasis/vim-devicons/issues/158
694+
[38] https://github.com/tiagofumo/vim-nerdtree-syntax-highlight
695+
[39] https://github.com/ryanoasis/vim-devicons/wiki/FAQ
696+
[40] https://github.com/ryanoasis/vim-devicons/wiki/Screenshots
697+
[41] https://github.com/ryanoasis/vim-devicons/issues
698+
[42] https://github.com/ryanoasis/vim-devicons
699+
[43] http://www.vim.org/scripts/script.php?script_id=5114
700+
[44] http://twitter.com/ryanlmcintyre
701+
[45] https://github.com/ryanoasis
702+
[46] https://atom.io/themes/seti-ui
703+
[47] http://vorillaz.github.io/devicons
704+
[48] https://github.com/benatespina/development.svg.icons
705+
[49] http://learnvimscriptthehardway.stevelosh.com/
706+
[50] https://github.com/ryanoasis/vim-devicons/graphs/contributors
707707

708708
vim: ft=help

0 commit comments

Comments
 (0)