pinyin

The hotoo/pinyin repository is a monorepo powered by turbo and pnpm. It contains several distinct packages for different usage scenarios:

• packages/pinyin: The core pinyin conversion engine.
• packages/pinyin-cli: A command-line tool that can be installed globally for use in any terminal environment.
• packages/pinyin-react: A React-specific version (marked as coming soon).
• apps/website: The documentation website.
• packages/tools: Miscellaneous tools used within the repository.

The pinyin library works in both Node.js and Web browsers, but there are key differences in capabilities:

Recommendation for Web users: To avoid performance hits on the client, it is recommended to convert Chinese to pinyin on the server and persist the results.

The PinyinTable component provides an audio-enabled interface for pronunciation practice and listening training. Users can click on any Pinyin to hear its pronunciation, which plays through the tones in order: first, second, third, and fourth tone.

The component accepts an i18n prop to localize the labels for initials, finals, and medial vowels.

<PinyinTable i18n={{
  initials: "Initials",
  finals: "Finals",
  medial_vowels_i: "Medial Vowels (i)",
  medial_vowels_u: "Medial Vowels (u)",
  medial_vowels_v: "Medial Vowels (ü)",
}} />

The pinyin-cli package allows you to convert Chinese characters to pīnyīn directly from your terminal. It can be installed globally for use anywhere in your system.

npm install pinyin-cli -g

# Usage examples
pinyin 中文
pinyin --help

To use the pinyin conversion tool in your Node.js or Web browser project, install the pinyin package using npm.

npm install pinyin --save

Install the pinyin package using npm to use it in your Node.js or Web projects.

npm install pinyin --save

The pinyin package is the core library for converting Chinese characters to pīnyīn. You can install it via npm and use the pinyin function to perform conversions.

npm install pinyin

import { pinyin } from 'pinyin';

const py = pinyin('中文');

To use the pinyin conversion tool in your project, install version 2 via npm:

npm install pinyin@2.0 --save

Run the pinyin command followed by the Chinese text you wish to convert to pinyin. Use pinyin -h to view the help menu.

pinyin 中文

Install the pinyin-cli globally using npm to use the pinyin command in your terminal.

npm i pinyin-cli -g

Install the pinyin-cli command line tool globally using npm to enable Chinese to Pinyin transformation from your terminal.

npm install pinyin-cli -g