You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* converted many links to reference style link
** more reusuable and easier to read readme source
* added links to plugins for section headers
* minor fixes
** contributors link
** reabability fixes
Copy file name to clipboardExpand all lines: readme.md
+48-32
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
vim-webdevicons
2
2
=======================
3
-
[](http://badge.fury.io/gh/ryanoasis%2Fvim-webdevicons)[](https://gitter.im/ryanoasis/vim-webdevicons?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[](https://flattr.com/submit/auto?user_id=ryanoasis&url=https://github.com/ryanoasis/vim-webdevicons&title=vim-webdevicons&language=viml&tags=github&category=software)
3
+
[][badge-version][][badge-gitter][][badge-flattr]
4
4
5
-
Adds filetype glyphs (icons) to other vim plugins such as [NERDTree](https://github.com/scrooloose/nerdtree), [vim-airline](https://github.com/bling/vim-airline), and [lightline.vim](https://github.com/itchyny/lightline.vim)
5
+
Adds filetype glyphs (icons) to other vim plugins such as [NERDTree], [vim-airline], and [lightline.vim].
6
6
7
7
[» Vote for upcoming features or suggest new ones](#vote)
8
8
@@ -37,7 +37,7 @@ End temporary poll section
37
37
- [Extra Configuration](#extra-configuration)
38
38
- [character mappings](#character-mappings)
39
39
- [Installation](#installation)
40
-
- [Lightline](#lightline)
40
+
- [Lightline](#lightline.vim)
41
41
- [Todo](#todo)
42
42
- [FAQ / Troubleshooting](#faq--troubleshooting)
43
43
- [Contributing](#contributing)
@@ -51,24 +51,23 @@ End temporary poll section
51
51
52
52
1. Install the plugin per your usual method _[(» More details... «)](#installation)_
53
53
2. Download and install a patched font (or patch your own):
54
-
*[nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher)_[(» More details... «)](#font-installation)_
54
+
*[nerd-filetype-glyphs-fonts-patcher]_[(» More details... «)](#font-installation)_
55
55
3. Set font _[(» More details... «)](#font-configuration)_
56
56
* a. If using **vim**: Set your terminal emulator font
57
57
* b. If using **gvim**: Set `guifont` in your `vimrc`
58
58
59
59
## Usage
60
60
61
-
After installing the patched font and setting the vim font just open [NERDTree](https://github.com/scrooloose/nerdtree)
62
-
or look at [vim-airline](https://github.com/bling/vim-airline) (statusline or tabline).
61
+
After installing the patched font and setting the vim font just open [NERDTree]
62
+
or look at [airline][vim-airline] (statusline or tabline).
63
63
64
-
*_NOTE:_ if you don't have a vim font set and are not running gvim you will
65
-
need to set the terminal font.
64
+
*_NOTE:_ if you don't `guifont` set and are not running gvim you will need to set the terminal font.
66
65
67
-
*_NOTE:_ for [NERDTree](https://github.com/scrooloose/nerdtree) support, you **must** configure vim to load NERDTree _before_ vim-webdevicons loads.
66
+
*_NOTE:_ for [NERDTree] support, you **must** configure vim to load NERDTree **_before_** vim-webdevicons loads.
68
67
69
-
*_NOTE:_ for [vim-airline](https://github.com/bling/vim-airline) support, you **must** configure vim to load vim-airline _before_ vim-webdevicons loads.
68
+
*_NOTE:_ for [vim-airline] support, you **must** configure vim to load vim-airline **_before_** vim-webdevicons loads.
70
69
71
-
*_NOTE:_ for better [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin) support, you _should_ configure vim to load nerdtree-git-plugin _before_ vim-webdevicons loads.
70
+
*_NOTE:_ for better [nerdtree-git-plugin] support, you _should_ configure vim to load nerdtree-git-plugin **_before_** vim-webdevicons loads.
72
71
73
72
## Font Configuration
74
73
@@ -81,7 +80,7 @@ or look at [vim-airline](https://github.com/bling/vim-airline) (statusline or ta
81
80
patched font.
82
81
83
82
Already patched fonts and the font patcher script are provided at:
You can find more fonts under my repository [nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts).
121
+
You can find more fonts under my [patched fonts repo][font-nerd-icons-patched-fonts].
* by default you should not *NEED* to configure anything to get the basics working
198
-
*_NOTE:_ You *NEED* to use one of the patched font provided or patch your own ([nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher)) _unless_ you want to configure the filetype to glyph mappings yourself for your current font
197
+
*_NOTE:_ You *NEED* to use one of the patched font provided or patch your own ([nerd-filetype-glyphs-fonts-patcher]) _unless_ you want to configure the filetype to glyph mappings yourself for your current font
199
198
* these options can be defined in your `vimrc` or `gvimrc`
200
199
* the following options are provided however for overriding
201
200
@@ -344,19 +343,19 @@ endfunction
344
343
## Todo
345
344
346
345
*[ ] more filetypes to support
347
-
*[x]~~make sure it works properly and does not conflict with [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin)~~
346
+
*[x]~~make sure it works properly and does not conflict with [nerdtree-git-plugin]~~
348
347
*[ ] customize filetype icon colors
349
348
*[ ] more customization options in general
350
349
*[ ] more specific FAQ and Troubleshooting help
351
350
352
351
## FAQ / Troubleshooting
353
352
354
353
* I don't want to use any of the fonts provided, I want to use font ABC
355
-
* try the font patcher: [nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher)
354
+
* try the font patcher: [nerd-filetype-glyphs-fonts-patcher]
356
355
* see font configuration above for more details
357
356
358
357
* It isn't working
359
-
* Are you using the patched font provided in the separate repo ([nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher)) or are you patching your own?
358
+
* Are you using the patched font provided in the separate repo ([nerd-filetype-glyphs-fonts-patcher]) or are you patching your own?
360
359
*_NOTE:_ if running vim and no font set it will default to the terminal font that is set
361
360
* check what the vim/gvim font is set to, from ex mode:
362
361
@@ -437,8 +436,8 @@ Best ways to contribute
437
436
### Promotion
438
437
439
438
Like the project? Please support to ensure continued development going forward:
440
-
* Star this repo on [GitHub](https://github.com/ryanoasis/vim-webdevicons)
441
-
* Follow the repo on [GitHub](https://github.com/ryanoasis/vim-webdevicons)
439
+
* Star this repo on [GitHub][vim-webdevicons-repo]
440
+
* Follow the repo on [GitHub][vim-webdevicons-repo]
442
441
* Vote for it on [vim.org](http://www.vim.org/scripts/script.php?script_id=5114)
443
442
* Follow me
444
443
* [Twitter](http://twitter.com/ryanlmcintyre)
@@ -457,17 +456,34 @@ After seeing the awesome theme for Atom (seti-ui) and the awesome plugins work d
0 commit comments