opentui

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

OpenTUI Skill

OpenTUI 技能

Canonical reference docs are authored once in sibling

docs/**/*.mdx

files.

Inside the OpenTUI repo, this skill root lives at

packages/web/src/content/

, so the same files are also visible at

packages/web/src/content/docs/**/*.mdx

标准参考文档仅编写在同级的

docs/**/*.mdx

文件中。

在OpenTUI仓库中，本技能的根目录位于

packages/web/src/content/

，因此相同的文件也可以在

packages/web/src/content/docs/**/*.mdx

路径下找到。

Path invariant

路径规则

```
/docs/<slug>
```
maps to
```
docs/<slug>.mdx
```
relative to this skill root

in the repo, that same slug maps to

packages/web/src/content/docs/<slug>.mdx

```
/docs/<slug>
```
对应本技能根目录下的
```
docs/<slug>.mdx
```
文件

在仓库中，该slug对应

packages/web/src/content/docs/<slug>.mdx

文件

Reading order by area

按领域划分的阅读顺序

Getting started:
```
/docs/getting-started
```
Core:
```
/docs/core-concepts/renderer
```
React:
```
/docs/bindings/react
```
Solid:
```
/docs/bindings/solid
```

Components:

/docs/components/text

/docs/components/input

Layout:
```
/docs/core-concepts/layout
```
Keyboard:
```
/docs/core-concepts/keyboard
```
Plugins:
```
/docs/plugins/slots
```
Reference:
```
/docs/reference/env-vars
```

入门指南：
```
/docs/getting-started
```
核心内容：
```
/docs/core-concepts/renderer
```
React：
```
/docs/bindings/react
```
Solid：
```
/docs/bindings/solid
```

组件：

/docs/components/text

、

/docs/components/input

布局：
```
/docs/core-concepts/layout
```
键盘：
```
/docs/core-concepts/keyboard
```
插件：
```
/docs/plugins/slots
```
参考文档：
```
/docs/reference/env-vars
```

Quick routing by intent

按需求快速导航

Intent(s)	Start here
`getting-started` , `installation` , `quickstart` , `intro`	`docs/getting-started.mdx`
`core` , `renderer` , `terminal` , `scrollback` , `lifecycle`	`docs/core-concepts/renderer.mdx`
`layout` , `flexbox` , `yoga` , `positioning`	`docs/core-concepts/layout.mdx`
`keyboard` , `input` , `keybindings` , `paste` , `focus`	`docs/core-concepts/keyboard.mdx`
`react` , `jsx` , `hooks` , `animation` , `testing`	`docs/bindings/react.mdx`
`solid` , `signals` , `jsx` , `hooks` , `animation` , `testing`	`docs/bindings/solid.mdx`
`plugins` , `plugin` , `slots` , `registry` , `extensions`	`docs/plugins/slots.mdx`
`text` , `styling` , `content` , `selection`	`docs/components/text.mdx`
`input` , `form` , `editing` , `focus`	`docs/components/input.mdx`
`env` , `environment` , `configuration` , `flags`	`docs/reference/env-vars.mdx`

For concrete component requests, jump straight to

docs/components/<name>.mdx

after the relevant entry page. For plugin implementation details, narrow from

docs/plugins/slots.mdx

into

docs/plugins/core.mdx

docs/plugins/react.mdx

, or

docs/plugins/solid.mdx

需求场景	起始文档
`getting-started` , `installation` , `quickstart` , `intro`	`docs/getting-started.mdx`
`core` , `renderer` , `terminal` , `scrollback` , `lifecycle`	`docs/core-concepts/renderer.mdx`
`layout` , `flexbox` , `yoga` , `positioning`	`docs/core-concepts/layout.mdx`
`keyboard` , `input` , `keybindings` , `paste` , `focus`	`docs/core-concepts/keyboard.mdx`
`react` , `jsx` , `hooks` , `animation` , `testing`	`docs/bindings/react.mdx`
`solid` , `signals` , `jsx` , `hooks` , `animation` , `testing`	`docs/bindings/solid.mdx`
`plugins` , `plugin` , `slots` , `registry` , `extensions`	`docs/plugins/slots.mdx`
`text` , `styling` , `content` , `selection`	`docs/components/text.mdx`
`input` , `form` , `editing` , `focus`	`docs/components/input.mdx`
`env` , `environment` , `configuration` , `flags`	`docs/reference/env-vars.mdx`

如果需要了解具体组件的相关内容，在阅读对应入门文档后直接跳转到

docs/components/<name>.mdx

。如果需要了解插件实现细节，可从

docs/plugins/slots.mdx

深入到

docs/plugins/core.mdx

、

docs/plugins/react.mdx

或

docs/plugins/solid.mdx

。

Current skill entry pages

当前技能的入口文档

```
docs/getting-started.mdx
```
```
docs/core-concepts/renderer.mdx
```
```
docs/core-concepts/layout.mdx
```
```
docs/core-concepts/keyboard.mdx
```
```
docs/bindings/react.mdx
```
```
docs/bindings/solid.mdx
```
```
docs/plugins/slots.mdx
```
```
docs/components/text.mdx
```
```
docs/components/input.mdx
```
```
docs/reference/env-vars.mdx
```

```
docs/getting-started.mdx
```
```
docs/core-concepts/renderer.mdx
```
```
docs/core-concepts/layout.mdx
```
```
docs/core-concepts/keyboard.mdx
```
```
docs/bindings/react.mdx
```
```
docs/bindings/solid.mdx
```
```
docs/plugins/slots.mdx
```
```
docs/components/text.mdx
```
```
docs/components/input.mdx
```
```
docs/reference/env-vars.mdx
```

Working rules

使用规则

Prefer the current entry pages first, then read narrower docs in the same section.
Read the sibling
```
docs/**/*.mdx
```
files directly instead of copying prose into this file.
Use stable
```
/docs/...
```
URLs when cross-referencing docs.

优先阅读当前入口文档，再阅读同领域下更细分的文档。
直接阅读同级的
```
docs/**/*.mdx
```
文件，不要将内容复制到本文件中。
交叉引用文档时，请使用稳定的
```
/docs/...
```
路径。