Skip to content

Commit

Permalink
Updated vim doc with latest readme updates (html2vimdoc)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryanoasis
ryanoasis committed May 16, 2015
1 parent ec1d59a commit 2d3b588
Showing 1 changed file with 100 additions and 57 deletions.
157 changes: 100 additions & 57 deletions doc/webdevicons.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*readme.txt* vim-webdevicons v0.4.0
*readme.txt* vim-webdevicons v0.4.2

===============================================================================
Contents ~
Expand All @@ -14,22 +14,23 @@ Contents ~
8. Extra Configuration |readme-extra-configuration|
1. character mappings |readme-character-mappings|
9. Installation |readme-installation|
10. Todo |readme-todo|
11. FAQ / Troubleshooting |readme-faq-troubleshooting|
12. Contributing |readme-contributing|
13. Rationale |readme-rationale|
14. Inspiration and special thanks |readme-inspiration-special-thanks|
15. License |readme-license|
16. References |readme-references|
10. Lightline |readme-lightline|
11. Todo |readme-todo|
12. FAQ / Troubleshooting |readme-faq-troubleshooting|
13. Contributing |readme-contributing|
14. Rationale |readme-rationale|
15. Inspiration and special thanks |readme-inspiration-special-thanks|
16. License |readme-license|
17. References |readme-references|

===============================================================================
*readme-introduction*
Introduction ~

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

- vim-webdevicons v0.4.0
- vim-webdevicons v0.4.2

- Usage
- Quick Setup (TL;DR)
Expand All @@ -42,6 +43,7 @@ airline [2]. Image: image (see reference [3])
- character mappings

- Installation
- Lightline
- Todo
- FAQ / Troubleshooting
- Contributing
Expand Down Expand Up @@ -69,7 +71,7 @@ Quick Setup (TL;DR) ~
1. Install the plugin per your usual method _More details_

2. Download and install a patched font (or patch your own) from: ryanoasis
/nerd-filetype-glyphs-fonts-patcher [4]_More details_
/nerd-filetype-glyphs-fonts-patcher [5]_More details_

3. Set terminal font (if using 'vim') or set 'guifont' in 'vimrc' (if using
'gvim') _More details_
Expand All @@ -82,18 +84,26 @@ Font Configuration ~
patched font.

Already patched fonts and the font patcher script are provided at: nerd-
filetype-glyphs-fonts-patcher [4]
filetype-glyphs-fonts-patcher [5]

It works without configuration _ONLY_ when used with a patched font provided in
the separate repository above. Install the font and add it to your 'vimrc' or
'gvimrc':

'vim set guifont=<FONT_NAME> <FONT_SIZE>'
Linux 'vim set guifont=<FONT_NAME> <FONT_SIZE>'

OS X and Windows 'vim set guifont=<FONT_NAME>:h<FONT_SIZE>'

e.g.

Linux
>
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
<
OS X and Windows
>
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types:h11
<
===============================================================================
*readme-font-installation*
Font Installation ~
Expand All @@ -104,41 +114,45 @@ folder. For example:
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
<
You can find more fonts under my repository nerd-filetype-glyphs-fonts-patcher
[5].
[6].

===============================================================================
*readme-screenshots*
Screenshots ~

Image: image (see reference [6])
Image: image (see reference [7])

- NERDTree:

Image: image (see reference [7])
Image: image (see reference [8])

- vim-airline
- statusline Image: image (see reference [8])
- tabline Image: image (see reference [9])
- statusline Image: image (see reference [9])
- tabline Image: image (see reference [10]) Image: image (see reference [11])

- Different patched fonts example:

Image: image (see reference [10])
Image: image (see reference [12])

- Glyph set test file

Image: image (see reference [11])
Image: image (see reference [13])

- Lightline:

Image: image (see reference [14])

-------------------------------------------------------------------------------
*readme-various-terminal-emulators*
Various Terminal Emulators ~

- gnome terminal

Image: image (see reference [12])
Image: image (see reference [15])

- Urxvt terminal

Image: image (see reference [13])
Image: image (see reference [16])

===============================================================================
*readme-features*
Expand All @@ -148,6 +162,10 @@ Features ~
currently supports:
- NERDTree [1]
- vim-airline [2] (statusline and tabline)
- lightline.vim [3] (statusline)

- see: Lightline for setup

- Adds a global config map of characters to file extensions (or entire
filenames)
- customizable and extendable filetype detections
Expand All @@ -161,7 +179,7 @@ Features ~
- supports full filename matches, by default:
- 'gruntfile.coffee, gruntfile.js, gruntfile.ls, gulpfile.coffee,
gulpfile.js, gulpfile.ls, dropbox'
- font patcher (nerd-filetype-glyphs-fonts-patcher [4])
- font patcher (nerd-filetype-glyphs-fonts-patcher [5])
- requires: python2, python-fontforge package
- example usage > ./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\
for\ Powerline.otf
Expand All @@ -174,7 +192,7 @@ Extra Configuration ~
working

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

- these options can be defined in your 'vimrc' or 'gvimrc'
Expand Down Expand Up @@ -252,17 +270,17 @@ Installation ~
This plugin follows the standard runtime path structure, and as such it can be
installed with a variety of plugin managers:

- Pathogen [14]
- Pathogen [17]
- 'git clone https://github.com/ryanoasis/vim-webdevicons ~/.vim/bundle/vim-
webdevicons'
- NeoBundle [15]
- NeoBundle [18]
- Add to vimrc:

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

'vim :so ~/.vimrc :NeoBundleInstall'

- Vundle [16]
- Vundle [19]

- Add to vimrc:

Expand All @@ -274,13 +292,31 @@ installed with a variety of plugin managers:

- copy all of the files into your '~/.vim' directory

===============================================================================
*readme-lightline*
Lightline ~

To add the appropriate icon to lightline [3], call the function
'WebDevIconsGetFileTypeSymbol()' in your '.vimrc'. For example, you might set
your filetype section to:
>
let g:lightline = {
\ 'component_function': {
\ 'filetype': 'MyFiletype',
\ }
\ }
function! MyFiletype()
return winwidth(0) > 70 ? (strlen(&filetype) ? &filetype . ' ' . WebDevIconsGetFileTypeSymbol() : 'no ft') : ''
endfunction
<
===============================================================================
*readme-todo*
Todo ~

- [ ] more filetypes to support
- [ ] make sure it works properly and does not conflict with nerdtree-git-
plugin [17]
plugin [20]
- [ ] customize filetype icon colors
- [ ] more customization options in general

Expand All @@ -290,14 +326,14 @@ FAQ / Troubleshooting ~

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

- try the font patcher: nerd-filetype-glyphs-fonts-patcher [4]
- try the font patcher: nerd-filetype-glyphs-fonts-patcher [5]

- see font configuration above for more details

- It isn't working

- Are you using the patched font provided in the separate repo (nerd-
filetype-glyphs-fonts-patcher [4]) or are you patching your own?
filetype-glyphs-fonts-patcher [5]) or are you patching your own?

- _NOTE:_ if running vim and no font set it will default to the terminal font
that is set
Expand Down Expand Up @@ -340,9 +376,9 @@ FAQ / Troubleshooting ~

```vim " NERDTress File highlighting function!
NERDTreeHighlightFile(extension, fg, bg, guifg, guibg) exec 'autocmd
filetype nerdtree highlight ' . a:extension .' ctermbg='. a:bg .'
FileType nerdtree highlight ' . a:extension .' ctermbg='. a:bg .'
ctermfg='. a:fg .' guibg='. a:guibg .' guifg='. a:guifg exec 'autocmd
filetype nerdtree syn match ' . a:extension .' #^\s+.*'. a:extension .'$#'
FileType nerdtree syn match ' . a:extension .' #^\s+.*'. a:extension .'$#'
endfunction

call NERDTreeHighlightFile('jade', 'green', 'none', 'green', '#151515')
Expand All @@ -357,7 +393,11 @@ FAQ / Troubleshooting ~
NERDTreeHighlightFile('css', 'cyan', 'none', 'cyan', '#151515') call
NERDTreeHighlightFile('coffee', 'Red', 'none', 'red', '#151515') call
NERDTreeHighlightFile('js', 'Red', 'none', '#ffa500', '#151515') call
NERDTreeHighlightFile('php', 'Magenta', 'none', '#ff00ff', '#151515') ```
NERDTreeHighlightFile('php', 'Magenta', 'none', '#ff00ff', '#151515')
'Note: If the colors still are not highlighting, try invoking such as:'
autocmd VimEnter * call NERDTreeHighlightFile('jade', 'green', 'none',
'green', '#151515') ``` per: https://github.com/ryanoasis/vim-
webdevicons/issues/49#issuecomment-101753558

- @todo: more specific FAQ and Troubleshooting help

Expand All @@ -384,11 +424,11 @@ Inspiration and special thanks ~

- vim-airline [2]
- nerdtree [1]
- nerdtree-git-plugin [17]
- seti-ui [18]
- devicons by Theodore Vorillas [19]
- benatespina development.svg.icons [20]
- Steve Losh [21]
- nerdtree-git-plugin [20]
- seti-ui [21]
- devicons by Theodore Vorillas [22]
- benatespina development.svg.icons [23]
- Steve Losh [24]

===============================================================================
*readme-license*
Expand All @@ -402,24 +442,27 @@ References ~

[1] https://github.com/scrooloose/nerdtree
[2] https://github.com/bling/vim-airline
[3] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.0/overall-screenshot.png
[4] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher
[5] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts
[6] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.0/vim.png
[7] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.0/nerdtree.png
[8] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.0/airline-statusline.png
[9] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.0/airline-tabline.png
[10] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.0/different-fonts-sample.png
[11] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.0/glyph-set-test.png
[12] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.0/terminal-gnome-sample.png
[13] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.0/terminal-urxvt-sample.png
[14] https://github.com/tpope/vim-pathogen
[15] https://github.com/Shougo/neobundle.vim
[16] https://github.com/gmarik/vundle
[17] https://github.com/Xuyuanp/nerdtree-git-plugin
[18] https://atom.io/themes/seti-ui
[19] http://vorillaz.github.io/devicons
[20] https://github.com/benatespina/development.svg.icons
[21] http://learnvimscriptthehardway.stevelosh.com/
[3] https://github.com/itchyny/lightline.vim
[4] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/overall-screenshot.png
[5] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher
[6] https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/tree/master/patched-fonts
[7] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/vim.png
[8] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/nerdtree.png
[9] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-statusline.png
[10] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-tabline-1.png
[11] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/airline-tabline-2.png
[12] https://raw.githubusercontent.com/wiki/ryanoasis/vim-webdevicons/screenshots/v0.4.2/different-fonts-sample.png
[13] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/glyph-set-test.png
[14] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/lightline.png
[15] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/terminal-gnome-sample.png
[16] https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.4.2/terminal-urxvt-sample.png
[17] https://github.com/tpope/vim-pathogen
[18] https://github.com/Shougo/neobundle.vim
[19] https://github.com/gmarik/vundle
[20] https://github.com/Xuyuanp/nerdtree-git-plugin
[21] https://atom.io/themes/seti-ui
[22] http://vorillaz.github.io/devicons
[23] https://github.com/benatespina/development.svg.icons
[24] http://learnvimscriptthehardway.stevelosh.com/

vim: ft=help

0 comments on commit 2d3b588

Please sign in to comment.