feat(docs): add bilingual package documentation site

2026-09-20 15:53:28 +08:00
parent 60f6f1fb1a
commit dc80bd8ae0
111 changed files with 6531 additions and 0 deletions
@@ -0,0 +1,44 @@
+---
+title: Define an action
+description: Add product-specific behavior while preserving automatic dependency collection.
+order: 20
+toc:
+  - id: declare-the-action
+    title: Declare the action
+  - id: custom-control
+    title: Custom control
+  - id: typed-values
+    title: Typed values
+---
+
+## Declare the action {#declare-the-action}
+
+Keep the command and its editor dependencies in one definition:
+
+```tsx
+const Mention = defineLexicalAction({
+  name: "mention",
+  label: "Insert mention",
+  nodes: [MentionNode],
+  plugins: [MentionPopoverPlugin],
+  execute: ({ editor }) => openMentionPicker(editor),
+})
+```
+
+The node and plugin are enabled whenever `<Mention />` appears inside `LexicalActions`.
+
+## Custom control {#custom-control}
+
+```tsx
+<Mention>
+  {({ disabled, execute }) => (
+    <MentionButton disabled={disabled} onSelect={execute} />
+  )}
+</Mention>
+```
+
+Replacing the visible control does not change dependency collection.
+
+## Typed values {#typed-values}
+
+The render context exposes `execute(value?)` with the action's value type. `onClick` is the no-argument shortcut for ordinary buttons.
@@ -0,0 +1,30 @@
+---
+title: Localize the editor
+description: Connect built-in labels and custom actions to the workspace internationalization runtime.
+order: 21
+toc:
+  - id: add-the-catalog
+    title: Add the catalog
+  - id: fallback
+    title: Fallback
+  - id: custom-labels
+    title: Custom labels
+---
+
+## Add the catalog {#add-the-catalog}
+
+```json
+{
+  "catalogSources": ["@workspace/lexical/locales/{locale}"]
+}
+```
+
+The package ships American English (`en-US`) and Simplified Chinese (`zh-Hans`) editor catalogs.
+
+## Fallback {#fallback}
+
+Built-in controls follow the active `@workspace/i18n` provider. Outside a provider, they fall back to English so the editor remains usable in isolated previews and tests.
+
+## Custom labels {#custom-labels}
+
+An external action label can be a plain string or a message descriptor containing `id` and `message`. Descriptors participate in the same extraction workflow as application copy.