{"id":43137811,"url":"https://github.com/longbridge/portai-docs","last_synced_at":"2026-01-31T22:09:00.115Z","repository":{"id":326497573,"uuid":"1103728872","full_name":"longbridge/portai-docs","owner":"longbridge","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-21T02:14:09.000Z","size":253,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-21T13:47:36.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/longbridge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-25T09:01:00.000Z","updated_at":"2025-12-22T03:16:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/longbridge/portai-docs","commit_stats":null,"previous_names":["longbridge/portai-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/longbridge/portai-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fportai-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fportai-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fportai-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fportai-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/longbridge","download_url":"https://codeload.github.com/longbridge/portai-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fportai-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28957066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T18:30:42.805Z","status":"ssl_error","status_checked_at":"2026-01-31T18:30:19.593Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-31T22:08:59.474Z","updated_at":"2026-01-31T22:09:00.110Z","avatar_url":"https://github.com/longbridge.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# PortAI Docs\n\n基于 Bun 和 VitePress 构建的现代化文档站点。\n\n## ✨ 特性\n\n- 🚀 **极速开发** - 使用 Bun 作为运行时，享受极致的开发体验\n- ⚡️ **快速构建** - 基于 Vite 的超快热更新和优化构建\n- 📝 **Markdown 驱动** - 专注于内容创作，使用 Markdown 编写文档\n- 🎨 **主题美观** - 现代化、响应式的用户界面\n- 🔍 **内置搜索** - 开箱即用的全文搜索功能\n- 🌐 **国际化支持** - 支持英文、简体中文、繁体中文三种语言\n\n## 📋 前置要求\n\n- [Bun](https://bun.sh) \u003e= 1.0.0\n- Node.js \u003e= 18.0.0（可选）\n\n## 🚀 快速开始\n\n### 安装依赖\n\n```bash\nbun install\n```\n\n### 本地开发\n\n启动开发服务器，支持热重载：\n\n```bash\nbun run docs:dev\n```\n\n访问 `http://localhost:5173` 查看文档站点。\n\n### 构建生产版本\n\n```bash\nbun run docs:build\n```\n\n构建产物将生成在 `docs/.vitepress/dist` 目录。\n\n### 预览生产构建\n\n```bash\nbun run docs:preview\n```\n\n## 📁 项目结构\n\n```\nportai-docs/\n├── docs/                    # 文档源文件\n│   ├── .vitepress/         # VitePress 配置\n│   │   └── config.mts      # 站点配置文件\n│   ├── guide/              # 英文指南文档\n│   │   ├── getting-started.md\n│   │   ├── configuration.md\n│   │   └── deployment.md\n│   ├── api/                # 英文 API 文档\n│   │   ├── introduction.md\n│   │   └── core.md\n│   ├── zh-CN/              # 简体中文文档\n│   │   ├── guide/\n│   │   ├── api/\n│   │   └── index.md\n│   ├── zh-HK/              # 繁体中文文档\n│   │   ├── guide/\n│   │   ├── api/\n│   │   └── index.md\n│   └── index.md            # 英文首页（默认）\n├── package.json\n└── README.md\n```\n\n## 📝 编写文档\n\n### 创建新页面\n\n1. 在 `docs/` 目录下创建新的 `.md` 文件\n2. 在 `docs/.vitepress/config.mts` 中添加导航或侧边栏配置\n3. 使用 Markdown 语法编写内容\n\n### Markdown 扩展\n\nVitePress 支持丰富的 Markdown 扩展：\n\n```markdown\n::: info\n这是一个信息提示框\n:::\n\n::: tip\n这是一个提示框\n:::\n\n::: warning\n这是一个警告框\n:::\n\n::: danger\n这是一个危险警告框\n:::\n```\n\n### 代码块\n\n支持语法高亮和行号：\n\n````markdown\n```typescript\nfunction hello(name: string) {\n  console.log(`Hello, ${name}!`)\n}\n```\n````\n\n## 🚀 部署\n\n### Vercel（推荐）\n\n1. 将代码推送到 GitHub\n2. 在 Vercel 导入仓库\n3. 配置构建设置：\n   - **Build Command**: `bun run docs:build`\n   - **Output Directory**: `docs/.vitepress/dist`\n   - **Install Command**: `bun install`\n\n### Netlify\n\n1. 将代码推送到 GitHub\n2. 在 Netlify 导入仓库\n3. 配置构建设置：\n   - **Build command**: `bun run docs:build`\n   - **Publish directory**: `docs/.vitepress/dist`\n\n### GitHub Pages\n\n使用 GitHub Actions 自动部署，参考 `docs/guide/deployment.md` 中的详细说明。\n\n## 🌐 多语言支持\n\n本项目支持三种语言：\n\n- **English** (默认) - `/`\n- **简体中文** - `/zh-CN/`\n- **繁體中文** - `/zh-HK/`\n\n### 添加新语言\n\n1. 在 `docs/` 下创建新的语言目录（如 `ja/` 用于日语）\n2. 复制文档结构到新目录\n3. 在 `docs/.vitepress/config.mts` 中添加语言配置：\n\n```typescript\nlocales: {\n  // ...existing locales\n  'ja': {\n    label: '日本語',\n    lang: 'ja',\n    themeConfig: {\n      nav: [...],\n      sidebar: [...]\n    }\n  }\n}\n```\n\n## 🛠️ 配置\n\n主要配置文件位于 `docs/.vitepress/config.mts`，您可以自定义：\n\n- 站点标题和描述\n- 导航栏和侧边栏\n- 多语言配置\n- 主题颜色和样式\n- 搜索功能\n- 社交链接\n- 更多...\n\n详细配置说明请查看 [配置文档](docs/guide/configuration.md)。\n\n## 📚 文档\n\n- [快速开始](docs/guide/getting-started.md) - 了解如何使用本项目\n- [配置说明](docs/guide/configuration.md) - 自定义您的文档站点\n- [部署指南](docs/guide/deployment.md) - 将文档部署到生产环境\n- [API 参考](docs/api/introduction.md) - API 文档示例\n\n## 🤝 贡献\n\n欢迎贡献！请随时提交 Issue 或 Pull Request。\n\n## 📄 许可证\n\n[MIT](LICENSE)\n\n## 🔗 相关链接\n\n- [VitePress 官方文档](https://vitepress.dev)\n- [Bun 官方文档](https://bun.sh/docs)\n- [Markdown 语法指南](https://www.markdownguide.org/)\n\n---\n\n使用 ❤️ 和 [Bun](https://bun.sh) + [VitePress](https://vitepress.dev) 构建\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongbridge%2Fportai-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flongbridge%2Fportai-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongbridge%2Fportai-docs/lists"}