Skip to content

Commit 1a8ad88

Browse files
ryanoasisryanoasis
committed
Updated vim doc with latest readme updates (html2vimdoc)
1 parent 9b6fb2c commit 1a8ad88

File tree

1 file changed

+138
-62
lines changed

1 file changed

+138
-62
lines changed

‎doc/webdevicons.txt

+138-62
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*readme.txt* vim-webdevicons v0.4.2
1+
*readme.txt* vim-webdevicons v0.4.3
22

33
===============================================================================
44
Contents ~
@@ -10,6 +10,9 @@ Contents ~
1010
5. Font Installation |readme-font-installation|
1111
6. Screenshots |readme-screenshots|
1212
1. Various Terminal Emulators |readme-various-terminal-emulators|
13+
2. Windows OS |readme-windows-os|
14+
3. Mac OS X |readme-mac-os-x|
15+
4. nerdtree-git-plugin |readme-nerdtree-git-plugin|
1316
7. Features |readme-features|
1417
8. Extra Configuration |readme-extra-configuration|
1518
1. character mappings |readme-character-mappings|
@@ -18,19 +21,24 @@ Contents ~
1821
11. Todo |readme-todo|
1922
12. FAQ / Troubleshooting |readme-faq-troubleshooting|
2023
13. Contributing |readme-contributing|
24+
1. Promotion |readme-promotion|
25+
2. Source code |readme-source-code|
2126
14. Rationale |readme-rationale|
2227
15. Inspiration and special thanks |readme-inspiration-special-thanks|
28+
1. Also thanks to the many contributors: |readme-also-thanks-to-many-contributors|
2329
16. License |readme-license|
2430
17. References |readme-references|
2531

2632
===============================================================================
2733
*readme-introduction*
2834
Introduction ~
2935

30-
Adds filetype glyphs (icons) to other vim plugins such as nerdtree [1] and vim-
31-
airline [2], and lightline.vim [3] Image: image (see reference [4])
36+
Adds filetype glyphs (icons) to other vim plugins such as NERDTree [1], vim-
37+
airline [2], and lightline.vim [3]
3238

33-
- vim-webdevicons v0.4.2
39+
Image: image (see reference [4])
40+
41+
- vim-webdevicons v0.4.3
3442

3543
- Usage
3644
- Quick Setup (TL;DR)
@@ -55,36 +63,44 @@ airline [2], and lightline.vim [3] Image: image (see reference [4])
5563
*readme-usage*
5664
Usage ~
5765

58-
After installing the patched font and setting the vim font just open nerdtree
59-
or look at vim-airline (statusline or tabline).
66+
After installing the patched font and setting the vim font just open NERDTree
67+
[1] or look at vim-airline [2] (statusline or tabline).
6068

6169
- _NOTE:_ if you don't have a vim font set and are not running gvim you will
6270
need to set the terminal font.
6371

64-
- _NOTE:_ for NERDTree support, you must configure vim to load NERDTree
65-
_before_ vim-webdevicons loads.
72+
- _NOTE:_ for NERDTree [1] support, you **must** configure vim to load
73+
NERDTree _before_ vim-webdevicons loads.
74+
75+
- _NOTE:_ for vim-airline [2] support, you **must** configure vim to load
76+
vim-airline _before_ vim-webdevicons loads.
77+
78+
- _NOTE:_ for better nerdtree-git-plugin [5] support, you _should_ configure
79+
vim to load nerdtree-git-plugin _before_ vim-webdevicons loads.
6680

6781
===============================================================================
6882
*readme-quick-setup*
6983
Quick Setup (TL;DR) ~
7084

71-
1. Install the plugin per your usual method _More details_
72-
85+
1. Install the plugin per your usual method _More details..._
7386
2. Download and install a patched font (or patch your own) from: ryanoasis
74-
/nerd-filetype-glyphs-fonts-patcher [5]_More details_
75-
76-
3. Set terminal font (if using 'vim') or set 'guifont' in 'vimrc' (if using
77-
'gvim') _More details_
87+
/nerd-filetype-glyphs-fonts-patcher [6]_More details..._
88+
3. Set font _More details..._
89+
4. a. If using 'vim': Set terminal font
90+
5. b. If using 'gvim': Set 'guifont' in 'vimrc'
7891

7992
===============================================================================
8093
*readme-font-configuration*
8194
Font Configuration ~
8295

96+
- Encoding **must** be set to UTF-8 for the glyphs to show 'vim set
97+
encoding=utf8'
98+
8399
- The _ONLY_ configuration needed should be setting the font vim uses to a
84100
patched font.
85101

86102
Already patched fonts and the font patcher script are provided at: nerd-
87-
filetype-glyphs-fonts-patcher [5]
103+
filetype-glyphs-fonts-patcher [6]
88104

89105
It works without configuration _ONLY_ when used with a patched font provided in
90106
the separate repository above. Install the font and add it to your 'vimrc' or
@@ -114,45 +130,64 @@ folder. For example:
114130
cd ~/.fonts && curl -fLo DroidSansMonoForPowerlinePlusNerdFileTypes.otf https://raw.githubusercontent.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/master/patched-fonts/Droid%20Sans%20Mono%20for%20Powerline%20Plus%20Nerd%20File%20Types.otf
115131
<
116132
You can find more fonts under my repository nerd-filetype-glyphs-fonts-patcher
117-
[6].
133+
[7].
118134

119135
===============================================================================
120136
*readme-screenshots*
121137
Screenshots ~
122138

123-
Image: image (see reference [7])
139+
Image: image (see reference [8])
124140

125141
- NERDTree:
126142

127-
Image: image (see reference [8])
143+
Image: image (see reference [9])
128144

129145
- vim-airline
130-
- statusline Image: image (see reference [9])
131-
- tabline Image: image (see reference [10]) Image: image (see reference [11])
146+
- statusline Image: image (see reference [10])
147+
- tabline Image: image (see reference [11])Image: image (see reference [12])
148+
- fileformats symbols Image: image (see reference [13])
132149

133150
- Different patched fonts example:
134151

135-
Image: image (see reference [12])
152+
Image: image (see reference [14])
136153

137154
- Glyph set test file
138155

139-
Image: image (see reference [13])
156+
Image: image (see reference [15])
140157

141158
- Lightline:
142159

143-
Image: image (see reference [14])
160+
Image: image (see reference [16])
144161

145162
-------------------------------------------------------------------------------
146163
*readme-various-terminal-emulators*
147164
Various Terminal Emulators ~
148165

149166
- gnome terminal
150167

151-
Image: image (see reference [15])
168+
Image: image (see reference [17])
152169

153170
- Urxvt terminal
154171

155-
Image: image (see reference [16])
172+
Image: image (see reference [18])
173+
174+
-------------------------------------------------------------------------------
175+
*readme-windows-os*
176+
Windows OS ~
177+
178+
Image: image (see reference [19])
179+
180+
-------------------------------------------------------------------------------
181+
*readme-mac-os-x*
182+
Mac OS X ~
183+
184+
help wanted: https://github.com/ryanoasis/vim-webdevicons/issues/32
185+
186+
-------------------------------------------------------------------------------
187+
*readme-nerdtree-git-plugin*
188+
nerdtree-git-plugin ~
189+
190+
Image: image (see reference [20])
156191

157192
===============================================================================
158193
*readme-features*
@@ -179,7 +214,7 @@ Features ~
179214
- supports full filename matches, by default:
180215
- 'gruntfile.coffee, gruntfile.js, gruntfile.ls, gulpfile.coffee,
181216
gulpfile.js, gulpfile.ls, dropbox'
182-
- font patcher (nerd-filetype-glyphs-fonts-patcher [5])
217+
- font patcher (nerd-filetype-glyphs-fonts-patcher [6])
183218
- requires: python2, python-fontforge package
184219
- example usage > ./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\
185220
for\ Powerline.otf
@@ -192,7 +227,7 @@ Extra Configuration ~
192227
working
193228

194229
- _NOTE:_ You _NEED_ to use one of the patched font provided or patch your
195-
own (nerd-filetype-glyphs-fonts-patcher [5]) _unless_ you want to configure
230+
own (nerd-filetype-glyphs-fonts-patcher [6]) _unless_ you want to configure
196231
the filetype to glyph mappings yourself for your current font
197232

198233
- these options can be defined in your 'vimrc' or 'gvimrc'
@@ -267,20 +302,23 @@ character mappings ~
267302
*readme-installation*
268303
Installation ~
269304

305+
- Sample Windows vimrc configuration 1 [21]
306+
- Sample Linux vimrc configuration 1 [22]
307+
270308
This plugin follows the standard runtime path structure, and as such it can be
271309
installed with a variety of plugin managers:
272310

273-
- Pathogen [17]
311+
- Pathogen [23]
274312
- 'git clone https://github.com/ryanoasis/vim-webdevicons ~/.vim/bundle/vim-
275313
webdevicons'
276-
- NeoBundle [18]
314+
- NeoBundle [24]
277315
- Add to vimrc:
278316

279317
"vim NeoBundle 'ryanoasis/vim-webdevicons'" * And install it:
280318

281319
'vim :so ~/.vimrc :NeoBundleInstall'
282320

283-
- Vundle [19]
321+
- Vundle [25]
284322

285323
- Add to vimrc:
286324

@@ -297,26 +335,31 @@ installed with a variety of plugin managers:
297335
Lightline ~
298336

299337
To add the appropriate icon to lightline [3], call the function
300-
'WebDevIconsGetFileTypeSymbol()' in your '.vimrc'. For example, you might set
301-
your filetype section to:
338+
'WebDevIconsGetFileTypeSymbol()' and/or 'WebDevIconsGetFileFormatSymbol()' in
339+
your '.vimrc'. For example, you could set your sections to:
302340
>
303341
let g:lightline = {
304342
\ 'component_function': {
305343
\ 'filetype': 'MyFiletype',
344+
\ 'fileformat': 'MyFileformat',
306345
\ }
307346
\ }
308347
309348
function! MyFiletype()
310349
return winwidth(0) > 70 ? (strlen(&filetype) ? &filetype . ' ' . WebDevIconsGetFileTypeSymbol() : 'no ft') : ''
311350
endfunction
351+
352+
function! MyFileformat()
353+
return winwidth(0) > 70 ? (&fileformat . ' ' . WebDevIconsGetFileFormatSymbol()) : ''
354+
endfunction
312355
<
313356
===============================================================================
314357
*readme-todo*
315358
Todo ~
316359

317360
- [ ] more filetypes to support
318-
- [ ] make sure it works properly and does not conflict with nerdtree-git-
319-
plugin [20]
361+
- [x] make sure it works properly and does not conflict with nerdtree-git-
362+
plugin [5]
320363
- [ ] customize filetype icon colors
321364
- [ ] more customization options in general
322365

@@ -326,14 +369,14 @@ FAQ / Troubleshooting ~
326369

327370
- I don't want to use any of the fonts provided, I want to use font ABC
328371

329-
- try the font patcher: nerd-filetype-glyphs-fonts-patcher [5]
372+
- try the font patcher: nerd-filetype-glyphs-fonts-patcher [6]
330373

331374
- see font configuration above for more details
332375

333376
- It isn't working
334377

335378
- Are you using the patched font provided in the separate repo (nerd-
336-
filetype-glyphs-fonts-patcher [5]) or are you patching your own?
379+
filetype-glyphs-fonts-patcher [6]) or are you patching your own?
337380

338381
- _NOTE:_ if running vim and no font set it will default to the terminal font
339382
that is set
@@ -405,6 +448,22 @@ FAQ / Troubleshooting ~
405448
*readme-contributing*
406449
Contributing ~
407450

451+
Best ways to contribute _Star it on GitHub - if you use it and like it please
452+
at least star it :)_ Promote _Open issues/tickets [26]_ Submit fixes and/or
453+
improvements with Pull Requests
454+
455+
-------------------------------------------------------------------------------
456+
*readme-promotion*
457+
Promotion ~
458+
459+
Like the project? Please support to ensure continued development going forward:
460+
_Star this repo on GitHub [27]_ Follow the repo on GitHub [27] _Vote for it on
461+
vim.org [28]_ Follow me **Twitter [29]** GitHub [30]
462+
463+
-------------------------------------------------------------------------------
464+
*readme-source-code*
465+
Source code ~
466+
408467
Contributions and pull requests are welcome.
409468

410469
No real formal process has been setup - just stick to general good conventions
@@ -424,11 +483,17 @@ Inspiration and special thanks ~
424483

425484
- vim-airline [2]
426485
- nerdtree [1]
427-
- nerdtree-git-plugin [20]
428-
- seti-ui [21]
429-
- devicons by Theodore Vorillas [22]
430-
- benatespina development.svg.icons [23]
431-
- Steve Losh [24]
486+
- nerdtree-git-plugin [5]
487+
- seti-ui [31]
488+
- devicons by Theodore Vorillas [32]
489+
- benatespina development.svg.icons [33]
490+
- Steve Losh [34]
491+
492+
-------------------------------------------------------------------------------
493+
*readme-also-thanks-to-many-contributors*
494+
Also thanks to the many contributors: ~
495+
496+
- contributors list [35]
432497

433498
===============================================================================
434499
*readme-license*
@@ -443,26 +508,37 @@ References ~
443508
[1] https://github.com/scrooloose/nerdtree
444509
[2] https://github.com/bling/vim-airline
445510
[3] https://github.com/itchyny/lightline.vim
446-
[4] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/overall-screenshot.png
447-
[5] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher
448-
[6] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts
449-
[7] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/vim.png
450-
[8] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/nerdtree.png
451-
[9] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-statusline.png
452-
[10] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-tabline-1.png
453-
[11] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-tabline-2.png
454-
[12] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/different-fonts-sample.png
455-
[13] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/glyph-set-test.png
456-
[14] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/lightline.png
457-
[15] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/terminal-gnome-sample.png
458-
[16] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/terminal-urxvt-sample.png
459-
[17] https://github.com/tpope/vim-pathogen
460-
[18] https://github.com/Shougo/neobundle.vim
461-
[19] https://github.com/gmarik/vundle
462-
[20] https://github.com/Xuyuanp/nerdtree-git-plugin
463-
[21] https://atom.io/themes/seti-ui
464-
[22] http://vorillaz.github.io/devicons
465-
[23] https://github.com/benatespina/development.svg.icons
466-
[24] http://learnvimscriptthehardway.stevelosh.com/
511+
[4] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/overall-screenshot.png
512+
[5] https://github.com/Xuyuanp/nerdtree-git-plugin
513+
[6] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher
514+
[7] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts
515+
[8] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/vim.png
516+
[9] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/nerdtree.png
517+
[10] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/airline-statusline.png
518+
[11] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/airline-tabline-1.png
519+
[12] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/airline-tabline-2.png
520+
[13] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/fileformats-symbols-sample.png
521+
[14] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/different-fonts-sample.png
522+
[15] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/glyph-set-test.png
523+
[16] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/lightline.png
524+
[17] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/terminal-gnome-sample.png
525+
[18] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/terminal-urxvt-sample.png
526+
[19] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/windows-sample.png
527+
[20] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/nerdtree-git-plugin-sample.png
528+
[21] https://github.com/ryanoasis/vim-webdevicons/wiki/samples/v0.4.3/.vimrc-windows-1
529+
[22] https://github.com/ryanoasis/vim-webdevicons/wiki/samples/v0.4.3/.vimrc-linux-1
530+
[23] https://github.com/tpope/vim-pathogen
531+
[24] https://github.com/Shougo/neobundle.vim
532+
[25] https://github.com/gmarik/vundle
533+
[26] https://github.com/ryanoasis/vim-webdevicons/issues
534+
[27] https://github.com/ryanoasis/vim-webdevicons
535+
[28] http://www.vim.org/scripts/script.php?script_id=5114
536+
[29] http://twitter.com/ryanlmcintyre
537+
[30] https://github.com/ryanoasis
538+
[31] https://atom.io/themes/seti-ui
539+
[32] http://vorillaz.github.io/devicons
540+
[33] https://github.com/benatespina/development.svg.icons
541+
[34] http://learnvimscriptthehardway.stevelosh.com/
542+
[35] https://github.com/ryanoasis/vim-webdevicons/network/members
467543

468544
vim: ft=help

0 commit comments

Comments
 (0)