Skip to content

Commit 475bafb

Browse files
AgentArcLabclaude
andcommitted
docs: 修 Fumadocs githubUrl 双mdx + markdownUrl basePath + README 图片绝对URL
1. page.tsx githubUrl: 去掉 .mdx 后缀(page.path 已含扩展名,之前拼成 index.mdx.mdx) 2. source.ts getPageMarkdownUrl: 用 assetPath 包裹加 basePath(GitHub Pages 在 /ksadk-python 子路径,复制 markdown URL 不带 basePath 导致 404) 3. README 4 张图改用绝对 raw URL 指向 docs-site/public/assets/(public-docs/ 已不在 main,相对链接 404) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent da51446 commit 475bafb

4 files changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache--2.0-blue?style=flat" /></a>
1717
</p>
1818

19-
<p align="center"><a href="public-docs/assets/ksadk-runtime-platform-hero.png"><img alt="KsADK 真实 CLI 截图:agentengine -h" src="public-docs/assets/ksadk-runtime-platform-hero-wide.png" width="860" /></a></p>
19+
<p align="center"><a href="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-runtime-platform-hero.png"><img alt="KsADK 真实 CLI 截图:agentengine -h" src="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-runtime-platform-hero-wide.png" width="860" /></a></p>
2020

2121
## 30 秒快速体验
2222

@@ -37,9 +37,9 @@ agentengine run -i
3737
agentengine web . --no-open
3838
```
3939

40-
<p align="center"><a href="public-docs/assets/ksadk-web-ui-screenshot.png"><img alt="KsADK 真实 Web UI 调试截图" src="public-docs/assets/ksadk-web-ui-screenshot.png" width="860" /></a></p>
40+
<p align="center"><a href="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-web-ui-screenshot.png"><img alt="KsADK 真实 Web UI 调试截图" src="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-web-ui-screenshot.png" width="860" /></a></p>
4141

42-
<p align="center"><a href="public-docs/assets/ksadk-local-debugging-demo.gif"><img alt="KsADK 真实本地 Web UI 演示" src="public-docs/assets/ksadk-local-debugging-demo.gif" width="860" /></a></p>
42+
<p align="center"><a href="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-local-debugging-demo.gif"><img alt="KsADK 真实本地 Web UI 演示" src="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-local-debugging-demo.gif" width="860" /></a></p>
4343

4444
## 为什么需要 KsADK
4545

@@ -53,7 +53,7 @@ agentengine web . --no-open
5353

5454
## 架构
5555

56-
<p align="center"><a href="public-docs/assets/ksadk-runtime-architecture.png"><img alt="KsADK Agent Runtime Platform 架构" src="public-docs/assets/ksadk-runtime-architecture.png" width="860" /></a></p>
56+
<p align="center"><a href="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-runtime-architecture.png"><img alt="KsADK Agent Runtime Platform 架构" src="https://raw.githubusercontent.com/kingsoftcloud/ksadk-python/main/docs-site/public/assets/ksadk-runtime-architecture.png" width="860" /></a></p>
5757

5858
## 文档与样例
5959

docs-site/app/[lang]/docs/[[...slug]]/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export default async function Page({
3636
<MarkdownCopyButton markdownUrl={markdownUrl} />
3737
<ViewOptionsPopover
3838
markdownUrl={markdownUrl}
39-
githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/docs-site/content/docs/${page.path}.mdx`}
39+
githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/docs-site/content/docs/${page.path}`}
4040
/>
4141
</div>
4242
</div>

docs-site/lib/source.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { docs } from 'collections/server';
44
import { loader } from 'fumadocs-core/source';
55
import { statusBadgesPlugin } from 'fumadocs-core/source/plugins/status-badges';
66
import { i18n } from './i18n';
7-
import { docsContentRoute, docsImageRoute, docsRoute } from './shared';
7+
import { docsContentRoute, docsImageRoute, docsRoute, assetPath } from './shared';
88

99
// See https://fumadocs.dev/docs/headless/source-api for more info
1010
export const source = loader({
@@ -47,7 +47,8 @@ export function getPageMarkdownUrl(page: (typeof source)['$inferPage']) {
4747

4848
return {
4949
segments,
50-
url: `${docsContentRoute}/${segments.join('/')}`,
50+
// GitHub Pages 在 /<repo> 子路径,markdown URL 需带 basePath,否则复制出来 404。
51+
url: assetPath(`${docsContentRoute}/${segments.join('/')}`),
5152
};
5253
}
5354

tests/test_public_release_positioning.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ def test_public_readme_positions_ksadk_as_runtime_platform():
2626
"文档与样例",
2727
"相关项目",
2828
"参与贡献",
29-
"public-docs/assets/ksadk-runtime-platform-hero-wide.png",
30-
"public-docs/assets/ksadk-web-ui-screenshot.png",
31-
"public-docs/assets/ksadk-local-debugging-demo.gif",
32-
"public-docs/assets/ksadk-runtime-architecture.png",
29+
"ksadk-runtime-platform-hero-wide.png",
30+
"ksadk-web-ui-screenshot.png",
31+
"ksadk-local-debugging-demo.gif",
32+
"ksadk-runtime-architecture.png",
3333
):
3434
assert expected in readme
3535

@@ -46,10 +46,10 @@ def test_public_readme_language_variants_keep_homepage_shape():
4646

4747
for text in (zh_readme, en_readme):
4848
assert "Kingsoft Cloud Agent Development Kit" in text
49-
assert "public-docs/assets/ksadk-runtime-platform-hero-wide.png" in text
50-
assert "public-docs/assets/ksadk-web-ui-screenshot.png" in text
51-
assert "public-docs/assets/ksadk-local-debugging-demo.gif" in text
52-
assert "public-docs/assets/ksadk-runtime-architecture.png" in text
49+
assert "ksadk-runtime-platform-hero-wide.png" in text
50+
assert "ksadk-web-ui-screenshot.png" in text
51+
assert "ksadk-local-debugging-demo.gif" in text
52+
assert "ksadk-runtime-architecture.png" in text
5353
assert "发布版本:" not in text
5454
assert "## 0.6." not in text
5555

0 commit comments

Comments
 (0)