mirror of
https://github.com/daylinmorgan/yartsu.git
synced 2024-11-12 17:23:15 -06:00
docs: add font/emoji info
This commit is contained in:
parent
2d3f76a27b
commit
0fa37082be
3 changed files with 79 additions and 1 deletions
10
Makefile
10
Makefile
|
|
@ -23,7 +23,7 @@ build/yartsu: $(SRC_FILES)
|
|||
install-bin: build/yartsu
|
||||
cp ./build/yartsu ~/bin
|
||||
|
||||
docs: svg-docs theme-docs
|
||||
docs: svg-docs theme-docs demo-docs
|
||||
|
||||
theme-docs:
|
||||
./scripts/theme-showcase-gen
|
||||
|
|
@ -32,6 +32,14 @@ svg-docs:
|
|||
lolcat -F .5 -S 9 -f assets/logo.txt | yartsu -o assets/logo.svg
|
||||
yartsu -o assets/yartsu.svg -t "yartsu --help" -- yartsu -h
|
||||
|
||||
demo-docs:
|
||||
python -c \
|
||||
"from rich.console import Console; \
|
||||
console = Console(force_terminal=True); \
|
||||
console.print('\n:snake: [b i]Emoji\'s!'); \
|
||||
console.print(' [cyan]Nerd Fonts!');" \
|
||||
| yartsu -w 25 -o assets/demo.svg
|
||||
|
||||
# https://stackoverflow.com/a/26339924
|
||||
list:
|
||||
@LC_ALL=C $(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$'
|
||||
|
|
|
|||
10
README.md
10
README.md
|
|
@ -108,6 +108,16 @@ You may also use the environment variable `YARTSU_THEME`.
|
|||
|
||||
See [here](https://github.com/daylinmorgan/yartsu/blob/main/docs/themes.md) a preview of the available themes
|
||||
|
||||
### Supported Characters
|
||||
|
||||
Currently `yartsu` loads the `nerd font` patched FiraCode font.
|
||||
This should result in general support for emoji's and `nerd font` icons.
|
||||
|
||||
<div align="center"><img src="https://raw.githubusercontent.com/daylinmorgan/yartsu/main/assets/demo.svg" alt="Logo" width=400 ></div>
|
||||
|
||||
**Note**: github won't load the font's when displaying on the README. Click on the `svg` to see the `nerd font` icons.
|
||||
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] add unit tests
|
||||
|
|
|
|||
60
assets/demo.svg
Normal file
60
assets/demo.svg
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
<svg class="rich-terminal" viewBox="0 0 323 123.19999999999999" xmlns="http://www.w3.org/2000/svg">
|
||||
<!-- Generated with Rich https://www.textualize.io -->
|
||||
<style>
|
||||
@font-face {
|
||||
font-family: "Fira Code";
|
||||
src: local("FiraCode-Regular"),
|
||||
url("https://cdn.jsdelivr.net/gh/ryanoasis/nerd-fonts@2.1.0/patched-fonts/FiraCode/Regular/complete/Fira%20Code%20Regular%20Nerd%20Font%20Complete.ttf") format("truetype");
|
||||
font-style: normal;
|
||||
font-weight: 400;
|
||||
}
|
||||
@font-face {
|
||||
font-family: "Fira Code";
|
||||
src: local("FiraCode-Bold"),
|
||||
url("https://cdn.jsdelivr.net/gh/ryanoasis/nerd-fonts@2.1.0/patched-fonts/FiraCode/Bold/complete/Fira%20Code%20Bold%20Nerd%20Font%20Complete.ttf") format("truetype");
|
||||
font-style: bold;
|
||||
font-weight: 700;
|
||||
}
|
||||
.terminal-601689729-matrix {
|
||||
font-family: Fira Code, monospace;
|
||||
font-size: 20px;
|
||||
line-height: 24.4px;
|
||||
font-variant-east-asian: full-width;
|
||||
}
|
||||
.terminal-601689729-title {
|
||||
font-size: 18px;
|
||||
font-weight: bold;
|
||||
font-family: arial;
|
||||
}
|
||||
.terminal-601689729-r1 { fill: #c6d0f5 }
|
||||
.terminal-601689729-r2 { fill: #c6d0f5;font-weight: bold;font-style: italic; }
|
||||
.terminal-601689729-r3 { fill: #94e2d5 }
|
||||
</style>
|
||||
<defs>
|
||||
<clipPath id="terminal-601689729-clip-terminal">
|
||||
<rect x="0" y="0" width="304.0" height="72.19999999999999" />
|
||||
</clipPath>
|
||||
<clipPath id="terminal-601689729-line-0">
|
||||
<rect x="0" y="1.5" width="305" height="24.65"/>
|
||||
</clipPath>
|
||||
<clipPath id="terminal-601689729-line-1">
|
||||
<rect x="0" y="25.9" width="305" height="24.65"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
<rect fill="#1e1e2e" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="321" height="121.2" rx="8"/><text class="terminal-601689729-title" fill="#c6d0f5" text-anchor="middle" x="160" y="27">yartsu</text>
|
||||
<g transform="translate(26,22)">
|
||||
<circle cx="0" cy="0" r="7" fill="#ff5f57"/>
|
||||
<circle cx="22" cy="0" r="7" fill="#febc2e"/>
|
||||
<circle cx="44" cy="0" r="7" fill="#28c840"/>
|
||||
</g>
|
||||
|
||||
<g transform="translate(9, 41)" clip-path="url(#terminal-601689729-clip-terminal)">
|
||||
|
||||
<g class="terminal-601689729-matrix">
|
||||
<text class="terminal-601689729-r1" x="305" y="20" textLength="12.2" clip-path="url(#terminal-601689729-line-0)">
|
||||
</text><text class="terminal-601689729-r1" x="0" y="44.4" textLength="24.4" clip-path="url(#terminal-601689729-line-1)">🐍 </text><text class="terminal-601689729-r2" x="36.6" y="44.4" textLength="97.6" clip-path="url(#terminal-601689729-line-1)">Emoji's!</text><text class="terminal-601689729-r1" x="305" y="44.4" textLength="12.2" clip-path="url(#terminal-601689729-line-1)">
|
||||
</text><text class="terminal-601689729-r1" x="0" y="68.8" textLength="36.6" clip-path="url(#terminal-601689729-line-2)">  </text><text class="terminal-601689729-r3" x="36.6" y="68.8" textLength="134.2" clip-path="url(#terminal-601689729-line-2)">Nerd Fonts!</text><text class="terminal-601689729-r1" x="305" y="68.8" textLength="12.2" clip-path="url(#terminal-601689729-line-2)">
|
||||
</text>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.2 KiB |
Loading…
Reference in a new issue