Skip to content

docs: add FAQ entry for Chinese character alignment issues#3997

Open
ehongon wants to merge 1 commit intoTextualize:masterfrom
ehongon:improve-faq-chinese
Open

docs: add FAQ entry for Chinese character alignment issues#3997
ehongon wants to merge 1 commit intoTextualize:masterfrom
ehongon:improve-faq-chinese

Conversation

@ehongon
Copy link

@ehongon ehongon commented Feb 18, 2026

Description

This PR adds a comprehensive FAQ entry to help Chinese developers resolve common display issues when using Rich with CJK (Chinese, Japanese, Korean) characters.

Changes

Added new FAQ entry: "Why do Chinese characters not align properly?"

The entry includes:

  • Explanation of why CJK characters (wide characters) may cause alignment issues
  • UTF-8 encoding configuration
  • Terminal recommendations by OS (Windows, macOS, Linux)
  • Font suggestions for CJK support
  • Windows-specific notes and workarounds
  • Code examples for troubleshooting

Why This Change?

  • Chinese developers frequently encounter alignment issues due to CJK characters being "wide" (2 columns)
  • Different terminals handle CJK character widths differently
  • This FAQ entry provides practical solutions for the most common scenarios
  • Complements the previous PR that added Chinese examples to README.cn.md

Related

This is a follow-up to PR #3996 which added Chinese-specific examples to README.cn.md.

Add comprehensive FAQ entry explaining why Chinese/CJK characters
may not align properly and provide solutions including:
- UTF-8 encoding configuration
- Terminal recommendations by OS
- Font suggestions for CJK support
- Windows-specific notes and workarounds

This helps Chinese developers resolve common display issues
when using Rich with CJK content.
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