Skip to content

Commit 4f499a0

Browse files
authored
docs(#453): add known issue: Windows and WSL not rendering icons properly on some terminals (#454)
Co-authored-by: barts <[email protected]>
1 parent 27eac98 commit 4f499a0

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,24 @@ These functions are the same as their counterparts without the `_by_filetype` su
197197

198198
You can also use `get_icon_name_by_filetype(filetype)` to get the icon name associated with the filetype.
199199

200+
## Known Issues
201+
202+
### Windows and WSL not rendering icons properly on some terminals
203+
204+
On Windows and WSL, it is possible that the icons are not rendered properly when
205+
using a terminal that relies on Windows' default system libraries. An example
206+
of this is Alacritty ([#271](https://github.com/nvim-tree/nvim-web-devicons/issues/271#issuecomment-2081280928)).
207+
Other terminals (e.g. Windows Terminal, and WezTerm) do no have this issue, as
208+
they ship newer versions of these libraries. More precisely, they use newer
209+
versions of `conpty.dll` and `OpenConsole.exe`. So, as a workaround to the
210+
rendering issue, you need to make your terminal use these newer files. Whether
211+
this is possible depends on the terminal you are using. Please refer to the
212+
terminal's documentation for this.
213+
214+
In the specific case of Alacritty, you need to place up-to-date `conpty.dll` and
215+
`OpenConsole.exe` files in your `PATH`. Microsoft does not provide these files
216+
directly, but you can get them from other terminal emulators that ship them.
217+
200218
## Contributing
201219

202220
PRs are always welcome! Please see [CONTRIBUTING](CONTRIBUTING.md)

0 commit comments

Comments
 (0)