一键在 Manus 中运行任何 Skill

api-short-link-to-mdx

星标3

分支42

更新时间2026年6月2日 03:22

This skill resolves ZEGO API short links (e.g., [sendSEI](@sendSEI)) to the corresponding local API reference MDX file. Use when reading documentation that contains [text](@apiName) format links and the API details need to be checked. Triggers on: "resolve api short link", "find api mdx", "解析 @ 短链", "@短链解析", "API 短链", "find the mdx for @link", "resolve @ short link", "查看 API 短链对应的文档". Not needed for full URLs or URL paths (use url-to-mdx instead).

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

ZEGOCLOUD

ZEGOCLOUD/docs_all

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

api-short-link-to-mdx

Resolve a ZEGO API short link (@apiName) to the local API reference MDX file, so the API documentation can be read directly.

When to use

Use this skill when encountering [text](@apiName) format links in ZEGO documentation, such as:

[startPublishingStream](@startPublishingStream)
[sendSEI](@sendSEI)
[ZegoExpressEngine](@-ZegoEngine)

This is the @ short link counterpart of the url-to-mdx skill (which handles URL paths like /real-time-video-web/...).

How to use

Run the helper script:

bash ${SKILL_ROOT}/scripts/resolve.sh <short_link> <current_mdx_path>

Arguments:

short_link: API name without the @ sign (e.g., startPublishingStream, sendSEI)
current_mdx_path: Path of the MDX file where the short link appears, relative to docs root

Output (4 lines on success):

instance ID (e.g., real_time_video_web_zh)
resolved URL path (e.g., /real-time-video-web/client-sdk/api-reference/class#startpublishingstream)
local MDX file absolute path
anchor slug for searching within the file

On failure, an error message is printed to stderr and the script exits with code 1.

Examples

# Resolve a method short link
bash ${SKILL_ROOT}/scripts/resolve.sh startPublishingStream core_products/real-time-voice-video/zh/web/quick-start.mdx
# => real_time_video_web_zh
# => /real-time-video-web/client-sdk/api-reference/class#startpublishingstream
# => /path/to/docs_all/core_products/real-time-voice-video/zh/web/client-sdk/api-reference/class.mdx
# => startpublishingstream

# Resolve an enum/class heading link
bash ${SKILL_ROOT}/scripts/resolve.sh "-ZegoEngine" core_products/real-time-voice-video/zh/web/quick-start.mdx

After resolution, read the returned MDX file and search for the anchor slug to find the specific API documentation.

Limitations

Only works for documents under an instance that has clientApiPath configured in docuo.config.json
Most core products (RTC, RTV, IM) have this configured; some solutions (KTV, etc.) may not
If resolution fails, the @ link may reference an API from a different product's instance — try resolving against a document from that product instead

同仓库更多 Skills

同仓库

doc-eval

ZEGOCLOUD/docs_all

This skill should be used when the user wants to evaluate documentation quality from multiple perspectives. Triggers on: Review 文档、评测文档、评估文档、doc eval、文档评价、文档质量、文档评测。

2026-06-163

make-integration-test

ZEGOCLOUD/docs_all

Use this skill when the user wants to run the full ZEGO documentation access-test workflow: documentation evaluation, demo construction, automated demo testing, final cross-stage synthesis, and optional Feishu publication. Triggers on: "集成测试", "接入测试", "文档接入测试", "make-integration-test", "integration test", "run full integration test", or when the user explicitly asks to both evaluate docs and verify a runnable integration demo. Do not use this skill when the user only wants doc evaluation, only wants to build a demo, or only wants to run tests; use the narrower skill directly in those cases.

2026-06-163

report-doc-test-in-feishu

ZEGOCLOUD/docs_all

Use this skill when the user needs to publish a ZEGO documentation access-test run to Feishu: create fixed report documents under the access-test Feishu node, correct doc-eval reports using build and auto-test results, write build/test and corrected doc-eval summary reports, upload source/test artifacts and screenshots, and return Feishu links. Triggers on: "写入飞书接入测试报告", "发布接入测试报告", "report-doc-test-in-feishu", "飞书报告", "生成飞书报告", or when make-integration-test reaches its Feishu publishing stage.

2026-06-163

edit-mdx-best-practices

ZEGOCLOUD/docs_all

This skill should be used when editing MDX files, writing MDX content, adding components to documentation, or formatting documentation in ZEGO docs. Triggers on "edit mdx", "write mdx", "add callout", "create tabs", "insert steps", "mdx component", "mdx syntax", "format documentation", "编写 MDX", "编辑 MDX", "添加组件".

2026-06-153

auto-test-demo

ZEGOCLOUD/docs_all

This skill should be used when the user wants to test a demo project — designing test cases, executing automated tests, taking screenshots, and packaging the project. Also handles creating test-cases.json and test-cases.sh for example code projects. Triggers on: "test demo", "run tests", "test the project", "验证功能", "测试 demo", "run test cases", "截图打包", "create test cases", "write test cases", "generate test cases", "design test cases for the demo", "create test-cases.json", "create test-cases.sh". Applicable to document example demos, access test demos, and competitive test demos.

2026-06-093

create-integration-demo

ZEGOCLOUD/docs_all

This skill should be used when the user wants to simulate a zero-experience developer following ZEGO documentation to build, code, compile, and verify a demo project. Triggers on: "构建集成测试项目", "按文档构建项目", "create integration demo", "构建验证", "模拟零经验开发者构建", "integration test build", "create-integration-demo". It can run standalone when the user provides documentation paths, and can optionally consume existing Markdown evaluation reports as background input.

2026-06-093

name

api-short-link-to-mdx

description

api-short-link-to-mdx

Resolve a ZEGO API short link (@apiName) to the local API reference MDX file, so the API documentation can be read directly.

When to use

Use this skill when encountering [text](@apiName) format links in ZEGO documentation, such as:

[startPublishingStream](@startPublishingStream)
[sendSEI](@sendSEI)
[ZegoExpressEngine](@-ZegoEngine)

This is the @ short link counterpart of the url-to-mdx skill (which handles URL paths like /real-time-video-web/...).

How to use

Run the helper script:

bash ${SKILL_ROOT}/scripts/resolve.sh <short_link> <current_mdx_path>

Arguments:

short_link: API name without the @ sign (e.g., startPublishingStream, sendSEI)
current_mdx_path: Path of the MDX file where the short link appears, relative to docs root

Output (4 lines on success):

instance ID (e.g., real_time_video_web_zh)
resolved URL path (e.g., /real-time-video-web/client-sdk/api-reference/class#startpublishingstream)
local MDX file absolute path
anchor slug for searching within the file

On failure, an error message is printed to stderr and the script exits with code 1.

Examples

# Resolve a method short link
bash ${SKILL_ROOT}/scripts/resolve.sh startPublishingStream core_products/real-time-voice-video/zh/web/quick-start.mdx
# => real_time_video_web_zh
# => /real-time-video-web/client-sdk/api-reference/class#startpublishingstream
# => /path/to/docs_all/core_products/real-time-voice-video/zh/web/client-sdk/api-reference/class.mdx
# => startpublishingstream

# Resolve an enum/class heading link
bash ${SKILL_ROOT}/scripts/resolve.sh "-ZegoEngine" core_products/real-time-voice-video/zh/web/quick-start.mdx

After resolution, read the returned MDX file and search for the anchor slug to find the specific API documentation.

Limitations

Only works for documents under an instance that has clientApiPath configured in docuo.config.json
Most core products (RTC, RTV, IM) have this configured; some solutions (KTV, etc.) may not
If resolution fails, the @ link may reference an API from a different product's instance — try resolving against a document from that product instead