dotfiles/nvim/.vim/plugged/vim-devicons/README.md
2024-06-19 00:06:56 +02:00

5.9 KiB

VimDevIcons - Add Icons to Your Plugins

version chat on gitter code of conduct prs welcome CI

Supports plugins such as NERDTree, vim-airline, CtrlP, powerline, denite, unite, lightline.vim, vim-startify, vimfiler, vim-buffet and flagship.

vim-devicons overall screenshot

See Screenshots for more.

Features

  • Adds filetype glyphs (icons) to various vim plugins.
  • Customizable and extendable glyphs settings.
  • Supports a wide range of file type extensions.
  • Supports popular full filenames, like .gitignore, node_modules, .vimrc, and many more.
  • Supports byte order marker (BOM).
  • Works with patched fonts, especially Nerd Fonts.

See Detailed Features for more.

See Configuration for a list of configuration and customization options.

Installation

  1. Install a Nerd Font compatible font or patch your own. Then set your terminal font (or guifont if you are using GUI version of Vim).

  2. Install the Vim plugin with your favorite plugin manager, e.g. vim-plug:

    Plug 'ryanoasis/vim-devicons'
    

    Always load the vim-devicons as the very last one.

  3. Configure Vim

    set encoding=UTF-8
    

    No need to set explicitly under Neovim: always uses UTF-8 as the default encoding.

See Installation for detailed setup instructions

Use :help devicons for further configuration.

Developers

See DEVELOPER for how to use the API.

Troubleshooting

See FAQ.

Contributing

Code of Conduct

This project has adopted a Code of Conduct that we expect project participants to adhere to. Check out code of conduct for further details.

Contributing Guide

Read our contributing guide to learn about how to send pull requests, creating issues properly.

Promotion

You can help us by simply giving a star or voting on vim.org. It will ensure continued development going forward.

Acknowledgments

Thanks goes to these people for inspiration and helping with sending PRs.

License

MIT