mn-docs-mcp 0.6.2 → 1.1.0

package/src/content/docs/libmn/locale.md

@@ -0,0 +1,307 @@
+---
+title: Locale
+description: LibMN中的Locale对象API文档。
+---
+
+`Locale`用于加载中英文文案配置并提供本地化读取、模板渲染和HUD展示能力。
+
+## 类成员(Class members)
+
+### 属性
+
+#### `preferredLanguages`
+
+#### 类型
+
+```ts
+static get preferredLanguages(): string[]
+```
+
+#### 说明
+
+返回系统偏好语言列表。
+
+#### 返回值
+
+- 类型:`string[]`
+- 语义:按系统优先级排序的语言标识数组。
+
+### 方法
+
+#### `init`
+
+#### 类型
+
+```ts
+static init(mainPath: string): void
+```
+
+#### 说明
+
+初始化本地化配置与语言状态。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `mainPath` | `string` | 是 | 插件根目录路径。 |
+
+#### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `copy`
+
+#### 类型
+
+```ts
+static copy(message: string): void
+```
+
+#### 说明
+
+把文本写入系统剪贴板。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `message` | `string` | 是 | 待复制文本。 |
+
+#### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `addZHConfig`
+
+#### 类型
+
+```ts
+static addZHConfig(config: Record<string,string>): void
+```
+
+#### 说明
+
+合并中文文案配置。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `config` | `Record<string,string>` | 是 | 键值形式的中文文案配置。 |
+
+#### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `addENConfig`
+
+#### 类型
+
+```ts
+static addENConfig(config: Record<string,string>): void
+```
+
+#### 说明
+
+合并英文文案配置。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `config` | `Record<string,string>` | 是 | 键值形式的英文文案配置。 |
+
+#### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `isfileExists`
+
+#### 类型
+
+```ts
+static isfileExists(path: string): boolean
+```
+
+#### 说明
+
+判断路径对应文件是否存在。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `path` | `string` | 是 | 文件路径。 |
+
+#### 返回值
+
+- 类型:`boolean`
+- 语义:存在时返回`true`。
+
+#### `readJSON`
+
+#### 类型
+
+```ts
+static readJSON(path: string): object|undefined
+```
+
+#### 说明
+
+读取JSON文件并返回对象。返回值结构在当前源码未暴露稳定结构，需按调用场景使用。
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `path` | `string` | 是 | JSON文件路径。 |
+
+#### 返回值
+
+- 类型:`object|undefined`
+- 语义:文件不存在或无效时返回`undefined`。
+
+#### `getZHNameForKey`
+
+#### 类型
+
+```ts
+static getZHNameForKey(key: string): string
+```
+
+#### 说明
+
+按键名读取中文文案。
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `key` | `string` | 是 | 文案键名。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:命中时返回中文文案，未命中回退到英文或键名本身。
+
+#### `getENNameForKey`
+
+#### 类型
+
+```ts
+static getENNameForKey(key: string): string
+```
+
+#### 说明
+
+按键名读取英文文案。
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `key` | `string` | 是 | 文案键名。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:命中时返回英文文案，未命中返回键名。
+
+#### `getLocalNameForKey`
+
+#### 类型
+
+```ts
+static getLocalNameForKey(key: string): string
+```
+
+#### 说明
+
+按当前语言读取文案。
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `key` | `string` | 是 | 文案键名。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:返回当前语言对应文案。
+
+#### `at`
+
+#### 类型
+
+```ts
+static at(key: string): string
+```
+
+#### 说明
+
+`getLocalNameForKey`的别名方法。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `key` | `string` | 是 | 文案键名。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:返回当前语言对应文案。
+
+#### `render`
+
+#### 类型
+
+```ts
+static render(template: string,additionalConfig?: Record<string,string>): string
+```
+
+#### 说明
+
+按当前语言配置渲染Mustache模板。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `template` | `string` | 是 | 模板字符串。 |
+| `additionalConfig` | `Record<string,string>` | 否 | 额外渲染变量。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:返回渲染后的字符串。
+
+#### `showHUD`
+
+#### 类型
+
+```ts
+static showHUD(message: string,additionalConfig?: Record<string,string>): void
+```
+
+#### 说明
+
+渲染本地化消息后调用`MNUtil.showHUD`展示提示。
+
+#### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `message` | `string` | 是 | 文案模板或普通文本。 |
+| `additionalConfig` | `Record<string,string>` | 否 | 额外渲染变量。 |
+
+#### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+## 实例成员(Instance members)
+
+无实例成员。

package/src/content/docs/libmn/menu.md

@@ -0,0 +1,77 @@
+---
+title: Menu
+description: LibMN中的Menu对象使用文档。
+---
+
+`Menu`是用于创建和管理弹出菜单的对象，在指定视图（如按钮或卡片）附近显示操作选项，构建和展示自定义菜单。
+
+## 构造函数
+
+```ts
+new Menu(sender: UIView|MNButton,delegate: object,width?: number,preferredPosition?: number)
+```
+
+构造一个新的Menu实例。
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:-------|:-----|:-----|:-----|
+| `sender` | `UIView\|MNButton` | 是 | 触发视图。 |
+| `delegate` | `object` | 是 | 代理对象。 |
+| `width` | `number` | 否 | 菜单宽度。 |
+| `preferredPosition` | `number` | 否 | 期望弹出方向。 |
+
+## 类成员(Class members)
+
+### 属性
+
+| 成员 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `popover` | `UIPopoverController\|undefined` | 当前全局菜单弹层实例。 |
+
+### 方法
+
+| 成员 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `item` | `static item(title: string,selector: string,params?: string,checked?: boolean): {title:string;selector:string;param:string;checked:boolean}` | 创建菜单项对象。 |
+| `dismissCurrentMenu` | `static dismissCurrentMenu(animate?: boolean): void` | 关闭当前全局菜单。 |
+
+## 实例成员(Instance members)
+
+### 属性
+
+| 成员 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `preferredPosition` | `number` | 期望弹出方向。`0`左侧，`1/3`下方，`2`上方，`4`右侧。 |
+| `titles` | `string[]` | 标题数组占位字段。通常用`menuItems`维护真实菜单内容。 |
+| `menuItems` | `Array<{title:string;object?:object;selector:string;param?:string;checked?:boolean}>` | 菜单项数组。 |
+| `rowHeight` | `number` | 每一行菜单项高度。 |
+| `fontSize` | `number` | 菜单字号。 |
+
+### 方法
+
+| 成员 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `constructor` | `constructor(sender: UIView,delegate: object,width?: number,preferredPosition?: number)` | 用触发视图和代理初始化菜单。 |
+| `addMenuItem` | `addMenuItem(title: string\|{key:string;prefix?:string;suffix?:string},selector: string,params?: string,checked?: boolean): void` | 追加一个菜单项。 |
+| `addItem` | `addItem(title: string\|{key:string;prefix?:string;suffix?:string},selector: string,params?: string,checked?: boolean): void` | `addMenuItem`别名。 |
+| `addMenuItems` | `addMenuItems(items: object[]): void` | 批量追加菜单项。 |
+| `addItems` | `addItems(items: object[]): void` | `addMenuItems`别名。 |
+| `insertMenuItem` | `insertMenuItem(index: number,title: string,selector: string,params?: string,checked?: boolean): void` | 在指定位置插入一个菜单项。 |
+| `insertMenuItems` | `insertMenuItems(index: number,items: object[]): void` | 在指定位置批量插入菜单项。 |
+| `show` | `show(autoWidth?: boolean,animate?: boolean): void` | 显示菜单。 |
+| `dismiss` | `dismiss(): void` | 关闭当前实例菜单并清空全局`popover`引用。 |
+
+## 快速示例
+
+```ts
+const menu = Menu.new(button, self, 220, 2)
+
+menu.menuItems = [
+  Menu.item('复制链接', 'onCopyLink:'),
+  Menu.item('删除卡片', 'onDeleteNote:', '', true)
+]
+
+menu.rowHeight = 38
+menu.fontSize = 15
+menu.show(true, true)
+```

package/src/content/docs/libmn/meta.json

@@ -0,0 +1,27 @@
+{
+  "title": "LibMN",
+  "pages": [
+    "index",
+    "runtime",
+    "headers",
+    "runtime-assets",
+    "runtime-web-view-host",
+    "internal-exposed",
+    "vendor-globals",
+    "locale",
+    "data-converter",
+    "frame",
+    "menu",
+    "mnbutton",
+    "mncomment",
+    "mnconnection",
+    "mndocument",
+    "mnextension-panel",
+    "mnnote",
+    "mnnotebook",
+    "mnutil",
+    "mnwebview",
+    "mustache",
+    "response"
+  ]
+}