Skip to content

docs: document Nerd Font + terminal setup for icon glyphs#13

Draft
roykollensvendsen wants to merge 1 commit into
mcjkula:mainfrom
roykollensvendsen:docs/nerd-font-requirement
Draft

docs: document Nerd Font + terminal setup for icon glyphs#13
roykollensvendsen wants to merge 1 commit into
mcjkula:mainfrom
roykollensvendsen:docs/nerd-font-requirement

Conversation

@roykollensvendsen

@roykollensvendsen roykollensvendsen commented Jun 20, 2026

Copy link
Copy Markdown

Problem

taolk's UI uses Nerd Font Material Design Icons (U+F0000U+F1AF0) plus box-drawing borders. The install docs only mention alsa-lib, so users on a machine without a Nerd Font hit one or more of:

  • tofu — icons render as blank/hex boxes (no Nerd Font installed)
  • misaligned borders — icons render but push columns out of alignment
  • invisible borders/text — low-contrast color schemes hide them

All three look like taolk bugs but are font/terminal configuration issues.

What I verified (GNOME Terminal / VTE, the common case)

  • The icon codepoints are Nerd Font MDI in the PUA; a normal font has no glyph there → tofu.
  • The symbols-only Symbols Nerd Font makes icons visible but renders them ~1.6 cells wide in VTE (measured via Pango: 21px vs a 13px cell). taolk lays each icon out as one cell, so the overflow breaks panel borders / column alignment. A full patched Nerd Font as the primary font renders icons at exactly 1.0 cell → aligned.
  • GNOME Terminal runs a single long-lived gnome-terminal-server; it loads fonts once at startup, so opening a new window after installing a font is not enough — the server (logout/login) must restart.
  • Low-contrast palettes (e.g. Solarized) make taolk's borders and dim text — drawn with ANSI "dark gray" — nearly invisible; a conventional palette fixes it.

Change

Adds a "A Nerd Font is required" section to the install docs:

  • recommend a full patched Nerd Font as the primary font (not symbols-only)
  • a "why not symbols-only" note explaining the VTE width/alignment issue
  • GNOME Terminal steps: install + fc-cache, restart the server, set the profile font, use a normal-contrast palette, and a tip to use a dedicated profile
  • a verification block: fc-match + a Pango font-selection check

Docs-only; no code changes.

Draft

Opened as draft for maintainer feedback on scope/wording. A follow-up could add an optional ASCII/narrow-icon mode so taolk degrades gracefully with no Nerd Font at all.

taolk's UI uses Nerd Font Material Design Icons (U+F0000-U+F1AF0) plus
box-drawing borders. Without the right font/terminal setup users get tofu
icons, misaligned borders, or invisible text -- which looks like a bug but is
a font/terminal configuration issue. The install docs only mentioned alsa-lib.

Add a "Nerd Font is required" section covering, with findings from testing:
- install a FULL patched Nerd Font as the primary font (recommended)
- why the symbols-only fallback is not enough: in VTE its glyphs render ~1.6
  cells wide and break border/column alignment
- GNOME Terminal: the single long-lived gnome-terminal-server must be
  restarted (logout/login) to pick up a newly installed font
- palette/contrast: low-contrast schemes (Solarized) hide borders and dim
  text; use a conventional palette; tip to use a dedicated profile
- verification: fc-match + a Pango font-selection check

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RoSjS1vtXJgJXw5Tbxroq4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant