docs-zh-cn: the official translation of the Vue documentation

A mirror with a strict rule about what it may change

This repository holds the Chinese version of the Vue documentation, served at cn.vuejs.org, and the README states its scope in a way that is unusual for a translation project. It is a mirror translation repository of the English documentation repository, and the project only syncs content and translates it, without including any extension, deletion or adaptation based on the English original. Any opinion or suggestion about the original content is asked for in the English repository, as an issue or a pull request. That rule is what keeps the two sites in step, and it also means the Chinese site inherits the structure of the English one rather than being a locally organised body of documentation. The site is described as being in a maintenance state, with the team syncing the English updates periodically, including both the documentation content and the frontend code, and the README invites four kinds of contribution, which are syncing the latest English changes, fixing typos or incorrect formatting, opening an issue to discuss translation choices or formatting, and opening an issue about the deployment or collaboration process.

The untranslated paragraph convention

Because a translation lags its source, the repository needs a way to mark the gaps, and it has one. The README says the documentation may occasionally contain paragraphs that are not yet translated, and that these are usually marked at the start with a `<!-- TODO: translation -->` comment. It then points readers at a search link that finds every remaining untranslated section in the source. This is a small mechanism with a large effect on how the project can be worked on, because it turns a vague notion of incompleteness into a queryable list, and it means a contributor can pick work by looking for a marker rather than by reading the whole tree to find what is missing. The wiki linked from the README is where the notes on the collaboration and deployment process live, and the README asks readers to visit it to understand the caveats before they start.

A linter that understands Chinese prose

The most distinctive piece of tooling is `zhlint`, a linter for Chinese text, which appears in the dependency list and in the lint script. The lint script runs it over the markdown files in the documentation directories, which are named explicitly as `api`, `about`, `guide`, `sponsor`, `translations` and `tutorial`, which tells you the section structure of the site. The configuration lives in a `.zhlintrc` file with a companion `.zhlintcaseignore` for exceptions, and the presence of a separate case ignore file is a hint about what such a linter checks, since Chinese has typographic conventions around punctuation and spacing that a general markdown linter would not know about. The formatting side is handled by prettier with its own configuration and a `.prettierignore`, and the editor configuration is in `.editorconfig`. The result is a repository where a Chinese translation is checked by Chinese rules, which is the difference between a translation and a pile of translated files.

The site stack, and where it is deployed

The documentation site is a VitePress application, with the `dev`, `build` and `preview` scripts mapping to the three VitePress commands, and VitePress pinned to an alpha release. The content is Vue, with the Vue repl package, the Vue theme package, and the GSAP and dynamics.js animation libraries. Two deployment targets are configured in the repository, with a `netlify.toml` and a `vercel.json`, which tells you the Chinese site is built on both platforms while the English site lives elsewhere. The build output is cleaned with a script that removes the `.vitepress/dist` directory, and the source content lives under `src/` with the site configuration in `.vitepress/`. The sync process itself is a script, `node scripts/sync.js`, with `simple-git` and `commander` in the development dependencies, which is what you would expect from a tool that pulls the English repository and applies the translation state on top.

A pnpm project with a strict toolchain

The local commands the README gives:

pnpm i
pnpm run dev
corepack enable

The package manifest is a good example of a repository that has settled on one package manager and enforces it. The `preinstall` script runs `npx only-allow pnpm`, so an accidental npm install fails instead of producing a broken tree, the `packageManager` field pins pnpm at 10.33.0, and the README recommends enabling corepack so that the pinned version is the one you get. Node 20 or higher is required, and the tree also carries a `.node-version` file for tools that read it. There is a pnpm override that forces VitePress to use a specific Vite release, and an `onlyBuiltDependencies` list naming esbuild and vue-demi, which are the packages allowed to run install scripts. Type checking is done with `vue-tsc --noEmit`, and the toolchain includes oxc-minify for the minifier and the VitePress plugins for group icons and for LLM oriented output, the latter of which is a hint that the site is being prepared to be read by models as well as by people.

Licence, credits and what a mirror repository owes its upstream

The copyright statement licenses the work under the Creative Commons Attribution, NonCommercial, ShareAlike 4.0 International licence, and that non-commercial element is worth noting if you plan to reuse the prose. The contributor picture is handled with a GitHub contributors graph link and a generated list of all contributors ordered by their total number of pull requests and commits, with the generation logic hosted in a separate repository, so the SVG badge in the README is regenerated rather than hand maintained. Taken together, the design is a careful piece of open source administration. The repository is not a fork in the code sense but a mirror of content, it defers every judgement call to upstream, it marks its own gaps with a searchable marker, it lints Chinese prose with Chinese rules, and it credits contributors mechanically. The main risk in that arrangement is drift, since a site that only syncs cannot improve on its source, and the README's own list of contribution types reflects that constraint.

Editorial conclusion

Adopt this repository if you read the Vue documentation in Chinese and want to contribute to it, or if you want a working VitePress documentation site to fork for your own product. Do not treat it as an authoritative source of Vue guidance, because it is a translation under a non-commercial licence, and the README is explicit that corrections and additions belong in the upstream English repository, not here. Before you contribute, read the wiki linked from the README, since it holds the notes on how this translation handles conflicts with upstream, and search for the translation TODO markers, because the untranslated paragraphs are marked in the source and the README links a search for them. The content is licensed CC BY-NC-SA 4.0, the last push was on 2026-10-13, and the repository publishes no GitHub releases.

Frequently asked questions

Official sources

1. Issues
2. Project website
3. README
4. vuejs-translations/docs-zh-cn on GitHub