Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seagle0128/icons-in-terminal.el
A utility package to propertize Icon Fonts in both GUI and TUI with Emacs.
https://github.com/seagle0128/icons-in-terminal.el
Last synced: 4 months ago
JSON representation
A utility package to propertize Icon Fonts in both GUI and TUI with Emacs.
- Host: GitHub
- URL: https://github.com/seagle0128/icons-in-terminal.el
- Owner: seagle0128
- License: gpl-3.0
- Created: 2019-04-08T15:58:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-28T21:27:14.000Z (almost 3 years ago)
- Last Synced: 2024-04-08T20:13:38.182Z (8 months ago)
- Language: Emacs Lisp
- Homepage:
- Size: 72.3 KB
- Stars: 35
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# icons-in-terminal.el
This package is inspired by [all-the-icons](https://github.com/domtronn/all-the-icons.el).
is a utility for using and formatting various icon fonts within Emacs. Icon
Fonts allow you to propertize and format icons the same way you would normal
text. This enables things such as better scaling of and anti aliasing of the
icons.
## Installation
### Install font
The Resource Font *MUST* be installed first to make the icons work in Emacs.
To display the icons in terminal emulator, set `icons-in-terminal` for Non-ASCII
font. *NOTE*: Not all terminal emulator support this functionality. Refer to
[icons-in-terminal](https://github.com/sebastiencs/icons-in-terminal) for details.
- Linux/Unix:
Refer to [Installing icons-in-terminal
font](https://github.com/sebastiencs/icons-in-terminal#installation).
``` shell
git clone https://github.com/sebastiencs/icons-in-terminal.git
cd icons-in-terminal
./install.sh
./print_icons.sh
```
- macOS/Windows
Run this command to install the necessary font based on the OS:
``` emacs-lisp
M-x icons-in-terminal-install-font
```
For Windows, the font is downloaded to the specified directory for installing
manually.
### Install elisp
``` shell
git clone https://github.com/seagle0128/icons-in-terminal.el
```
Add the path to `load-path`, then
``` emacs-lisp
(require 'icons-in-terminal)
```
## Usage
The interfaces are same as `all-the-icons`.
For example：
``` emacs-lisp
(icons-in-terminal-insert)
(icons-in-terminal-insert-faicon)
(icons-in-terminal-faicon "book")
(icons-in-terminal-icon-for-buffer)
(icons-in-terminal-icon-for-mode 'emacs-lisp-mode)
(icons-in-terminal-icon-for-file "template.el")
```