@model-go/docs-core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+export type DocsLang = 'zh' | 'en';
+export type DocsSiteProfile = 'cn' | 'global';
+export interface DocsNavPage {
+    id: string;
+    title: string;
+    slug: string;
+    description?: string;
+}
+export interface DocsNavSection {
+    id: string;
+    title: string | null;
+    pages: DocsNavPage[];
+    children?: DocsNavSection[];
+}
+export interface DocsNavResult {
+    title: string;
+    description: string;
+    sections: DocsNavSection[];
+}
+export interface DocsTocItem {
+    id: string;
+    title: string;
+    level: number;
+}
+export interface DocsPage {
+    slug: string;
+    title: string;
+    html: string;
+    markdown: string;
+    toc: DocsTocItem[];
+}
+/**
+ * 站点的模型调用网关地址（正文里的 `{{ api_endpoint }}` 用的同一个值）。
+ *
+ * 首页 hero 的「Base URL」卡片过去写死成 `/api/v1`——相对路径对用户毫无意义（他们要的是
+ * 能直接粘进 SDK 的完整地址），而且国内/国际两站显示同一个值。这里导出真源给它复用，
+ * 避免再各写一份（需求方 shared/modelgo_prd#376「文档内也需要更新」）。
+ */
+export declare function siteApiEndpoint(profile: DocsSiteProfile): string;
+export declare function getDocsNav(lang: DocsLang, profile: DocsSiteProfile): Promise<DocsNavResult>;
+export interface DocsRenderOptions {
+    /** 站内文档链接前缀，默认 ''（文档站自身根）。 */
+    linkBase?: string;
+    /** 站内图片前缀，默认 ''。 */
+    assetBase?: string;
+}
+export declare function getDocsPage(slug: string, lang: DocsLang, profile: DocsSiteProfile, render?: DocsRenderOptions): Promise<DocsPage>;
+export interface DocsSearchResult {
+    slug: string;
+    title: string;
+    excerpt: string;
+}
+export declare function searchDocs(query: string, lang: DocsLang, profile: DocsSiteProfile, limit?: number): DocsSearchResult[];
+/**
+ * 某站点 + 语言下的全部文档 slug（相对 <profile>/<lang>/ 的文件路径，无扩展名）。
+ * 官网构建期用它生成静态路由（getStaticPaths）。
+ */
+export declare function getDocSlugs(lang: DocsLang, profile: DocsSiteProfile): string[];
+/**
+ * 更新日志（仓库根 changelog.md）：不分市场/语言，只有一份。
+ * 它原来走 VitePress 自己的页面渲染（客户端再渲染），并入官网后同样要吃服务端 HTML。
+ */
+export declare function getChangelog(profile: DocsSiteProfile, render?: DocsRenderOptions): {
+    title: string;
+    html: string;
+    toc: DocsTocItem[];
+};