Skip to content

Commit 6284567

Browse files
committed
Update readme.md
* 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
1 parent 3d550c8 commit 6284567

File tree

1 file changed

+48
-32
lines changed

1 file changed

+48
-32
lines changed

readme.md

+48-32
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
vim-webdevicons
22
=======================
3-
[![GitHub version](https://badge.fury.io/gh/ryanoasis%2Fvim-webdevicons.svg)](http://badge.fury.io/gh/ryanoasis%2Fvim-webdevicons) [![Join the chat at https://gitter.im/ryanoasis/vim-webdevicons](https://img.shields.io/badge/%E2%8A%AA%20GITTER%20-CHAT%20%E2%86%92-1dce73.svg?style=flat)](https://gitter.im/ryanoasis/vim-webdevicons?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Flattr this git repo](https://img.shields.io/badge/donate-flatter%20this!-8DB65B.svg?style=flat)](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+
[![GitHub version](https://badge.fury.io/gh/ryanoasis%2Fvim-webdevicons.svg)][badge-version] [![Join the chat at https://gitter.im/ryanoasis/vim-webdevicons](https://img.shields.io/badge/%E2%8A%AA%20GITTER%20-CHAT%20%E2%86%92-1dce73.svg?style=flat)][badge-gitter] [![Flattr this git repo](https://img.shields.io/badge/donate-flattr%20this!-8DB65B.svg?style=flat)][badge-flattr]
44

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].
66

77
[» Vote for upcoming features or suggest new ones](#vote)
88

@@ -37,7 +37,7 @@ End temporary poll section
3737
- [Extra Configuration](#extra-configuration)
3838
- [character mappings](#character-mappings)
3939
- [Installation](#installation)
40-
- [Lightline](#lightline)
40+
- [Lightline](#lightline.vim)
4141
- [Todo](#todo)
4242
- [FAQ / Troubleshooting](#faq--troubleshooting)
4343
- [Contributing](#contributing)
@@ -51,24 +51,23 @@ End temporary poll section
5151

5252
1. Install the plugin per your usual method _[(» More details... «)](#installation)_
5353
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)_
5555
3. Set font _[(» More details... «)](#font-configuration)_
5656
* a. If using **vim**: Set your terminal emulator font
5757
* b. If using **gvim**: Set `guifont` in your `vimrc`
5858

5959
## Usage
6060

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).
6363

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.
6665

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.
6867

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.
7069

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.
7271

7372
## Font Configuration
7473

@@ -81,7 +80,7 @@ or look at [vim-airline](https://github.com/bling/vim-airline) (statusline or ta
8180
patched font.
8281

8382
Already patched fonts and the font patcher script are provided at:
84-
[nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher)
83+
[nerd-filetype-glyphs-fonts-patcher]
8584

8685
It works without configuration *ONLY* when used with a patched font provided in
8786
the separate repository above. Install the font and add it to your `vimrc` or
@@ -119,18 +118,18 @@ cd ~/.fonts && curl -fLo DroidSansMonoForPowerlinePlusNerdFileTypes.otf https://
119118
```
120119

121120

122-
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].
123122

124123

125124
## Screenshots
126125

127126
![image](https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/vim.png)
128127

129-
### NERDTree
128+
### [NERDTree]
130129

131130
![image](https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/nerdtree.png)
132131

133-
### vim-airline
132+
### [vim-airline]
134133

135134
section | preview
136135
------------------- | -------------
@@ -143,11 +142,11 @@ fileformats symbols | ![image](https://raw.githubusercontent.com/wiki/ryanoasis/
143142

144143
![image](https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.3/different-fonts-sample.png)
145144

146-
### Lightline
145+
### [lightline.vim][lightline.vim]
147146

148147
![image](https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/lightline.png)
149148

150-
### nerdtree-git-plugin
149+
### [nerdtree-git-plugin]
151150

152151
![image](https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.3/nerdtree-git-plugin-sample.png)
153152

@@ -175,10 +174,10 @@ fileformats symbols | ![image](https://raw.githubusercontent.com/wiki/ryanoasis/
175174

176175
## Features
177176
* show developer file type glyphs from a font in various vim plugins, currently supports:
178-
* [NERDTree](https://github.com/scrooloose/nerdtree)
179-
* [vim-airline](https://github.com/bling/vim-airline) (statusline and tabline)
180-
* [lightline.vim](https://github.com/itchyny/lightline.vim) (statusline)
181-
* see: [Lightline](#lightline) for setup
177+
* [NERDTree]
178+
* [vim-airline][vim-airline] (statusline and tabline)
179+
* [lightline.vim][lightline.vim] (statusline)
180+
* see: [lightline](#lightline) for setup
182181
* Adds a global config map of characters to file extensions (or entire filenames)
183182
* customizable and extendable filetype detections
184183
* ability to override predefined dictionary variable
@@ -187,15 +186,15 @@ fileformats symbols | ![image](https://raw.githubusercontent.com/wiki/ryanoasis/
187186
* ```styl, scss, htm, html, css, less, md, json, js, rb, php, py, pyc, pyd, pyo, coffee, mustache, hbs, conf, ini, yml, jpg, jpeg, bmp, png, gif, ai, twig, cpp, c++, cc, cp, cxx, cpp, c, hs, lhs, lua, sh, diff, clj, dart, db, go, scala, sln, suo, xul```
188187
* supports full filename matches, by default:
189188
* ```gruntfile.coffee, gruntfile.js, gruntfile.ls, gulpfile.coffee, gulpfile.js, gulpfile.ls, dropbox```
190-
* font patcher ([nerd-filetype-glyphs-fonts-patcher](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher))
189+
* font patcher ([nerd-filetype-glyphs-fonts-patcher])
191190
* requires: python2, python-fontforge package
192191
* example usage
193192
> ./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
194193

195194
## Extra Configuration
196195

197196
* 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
199198
* these options can be defined in your `vimrc` or `gvimrc`
200199
* the following options are provided however for overriding
201200

@@ -344,19 +343,19 @@ endfunction
344343
## Todo
345344

346345
* [ ] 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]~~
348347
* [ ] customize filetype icon colors
349348
* [ ] more customization options in general
350349
* [ ] more specific FAQ and Troubleshooting help
351350

352351
## FAQ / Troubleshooting
353352

354353
* 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]
356355
* see font configuration above for more details
357356

358357
* 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?
360359
* _NOTE:_ if running vim and no font set it will default to the terminal font that is set
361360
* check what the vim/gvim font is set to, from ex mode:
362361

@@ -437,8 +436,8 @@ Best ways to contribute
437436
### Promotion
438437
439438
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]
442441
* Vote for it on [vim.org](http://www.vim.org/scripts/script.php?script_id=5114)
443442
* Follow me
444443
* [Twitter](http://twitter.com/ryanlmcintyre)
@@ -457,17 +456,34 @@ After seeing the awesome theme for Atom (seti-ui) and the awesome plugins work d
457456
458457
## Inspiration and special thanks
459458
460-
* [vim-airline](https://github.com/bling/vim-airline)
461-
* [nerdtree](https://github.com/scrooloose/nerdtree)
462-
* [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin)
459+
* [vim-airline]
460+
* [nerdtree]
461+
* [nerdtree-git-plugin]
463462
* [seti-ui](https://atom.io/themes/seti-ui)
464463
* [devicons by Theodore Vorillas](http://vorillaz.github.io/devicons)
465464
* [benatespina development.svg.icons](https://github.com/benatespina/development.svg.icons)
466465
* [Steve Losh](http://learnvimscriptthehardway.stevelosh.com/)
467466
468467
### Also thanks to the many contributors:
469-
* [contributors list](https://github.com/ryanoasis/vim-webdevicons/network/members)
468+
* [contributors list](https://github.com/ryanoasis/vim-webdevicons/graphs/contributors)
470469
471470
## License
472471
473472
See [LICENSE](LICENSE)
473+
474+
<!---
475+
Link References
476+
-->
477+
478+
[nerd-filetype-glyphs-fonts-patcher]:https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher
479+
[font-nerd-icons-patched-fonts]:https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts
480+
[NERDTree]:https://github.com/scrooloose/nerdtree
481+
[vim-airline]:https://github.com/bling/vim-airline
482+
[lightline.vim]:https://github.com/itchyny/lightline.vim
483+
[lightline]:https://github.com/itchyny/lightline.vim
484+
[nerdtree-git-plugin]:https://github.com/Xuyuanp/nerdtree-git-plugin
485+
486+
[vim-webdevicons-repo]:https://github.com/ryanoasis/vim-webdevicons
487+
[badge-version]:http://badge.fury.io/gh/ryanoasis%2Fvim-webdevicons
488+
[badge-gitter]:https://gitter.im/ryanoasis/vim-webdevicons?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
489+
[badge-flattr]:https://flattr.com/submit/auto?user_id=ryanoasis&url=https://github.com/ryanoasis/vim-webdevicons&title=vim-webdevicons&language=viml&tags=github&category=software

0 commit comments

Comments
 (0)