Skip to content

docs: add Simplified Chinese README translation (README_zh.md) - #240

Open
WanderLandWalker wants to merge 1 commit into
yoavbls:mainfrom
WanderLandWalker:zh-readme
Open

WanderLandWalker wants to merge 1 commit into
yoavbls:mainfrom
WanderLandWalker:zh-readme

Conversation

@WanderLandWalker

Copy link
Copy Markdown

What this does

Adds a Simplified Chinese translation of the README as README_zh.md to help Chinese-speaking developers discover and adopt Pretty TypeScript Errors.

  • Purely additive: one new file, no existing files modified.
  • Preserved unchanged (byte-for-byte): every HTML block — the style="display: none" <picture> logo, the four Hype section <a><picture><source><img></picture></a> blocks, and the contributor <table> (including the source's malformed <a/> closing tags, the images.weserv.nl/?url=…&fit=cover&mask=circle avatar URLs, width/height attributes, <br> and &nbsp; &nbsp; spacing); every alt attribute verbatim (Logo, Watch theo's video, Webstorm logo, Winning the Productivity Booster category at JSNation 2023, Tanner's tweet, Theo's tweet, Johnson's tweet) and all contributor display names (Kent C. Dodds, Matt Pocock, Alex / KATT, Tanner Linsley, Theo Browne); the full shields/badgen badge block (alt labels, badge URLs and target URLs incl. style=social&label=Star, Visual%20Studio%20Code-0078d7?logo=visualstudiocode&logoColor=white, ?raw=true, and the #gh-dark-mode-only/#gh-light-mode-only/#user-content-jetbrains-support fragments); the single ``` code fence (code --install-extension yoavbls.pretty-ts-errors); all inline-code identifiers (`.ts`/`.js`/`.jsx`/`.tsx`/`.mdx`/`.astro`/`.svelte`/`.vue`/`.hbs`/`.gjs`/`.gts`, `... more ...`, `{ ... }`, `type X = ...`, `type`, `pretty-ts-errors`, `"..."`); the `🫂` emoji; every URL; and the `# Pretty `TypeScript` Errors` product-name heading.
  • Relative link target ./docs/hide-original-errors.md kept verbatim so it still resolves; its display text was translated. The source README contains no in-page ](#…) anchor links, so nothing needed to be pinned.
  • Translated: the <b> tagline text, the section headings (观看视频 / 特性 / 支持范围 / 安装 / 为什么这事儿并不简单 / 高光时刻 / 大咖加持 / 赞助 / 贡献 and the #### subheading), the intro/feature/support/why prose, the numbered list, the closing paragraphs, and the human-readable link display text that is ordinary prose (e.g. [这里] from "here", [更多] from "more"). Tool/product/channel names used as link text — VSCode marketplace, typescript.tv, ts-error-translator, Web Dev Simplified, Josh tried coding, trash dev — were intentionally left in English, as were the contributor names.
  • A top banner links back to the canonical English README.md.

Note on AI assistance

This translation was produced with AI assistance and independently reviewed for accuracy, formatting, and license/compliance before submission. The project is MIT licensed.

Becoming a Contributor

I read CONTRIBUTING.md. It opens with "All types of contributions are encouraged and valued"; the "prefer an existing issue to link to" guidance is scoped specifically to source-code PRs, and it states that documentation lives in README.md (i.e. in this repo, not routed elsewhere); there is no AI/LLM restriction and no DCO or CLA. So this purely additive README translation follows the normal fork → pull-request flow. I would love to become a Contributor to this repository, and I'm happy to match any preferred convention and keep the translation in sync as the English README evolves.

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