Skip to content

About

Resources

Stars

2 stars

Watchers

1 watching

Forks

Repository files navigation

AthenaDocsNG

YesImBot v4 官方文档站,由 Fumadocs + Next.js 静态导出构建。在线地址:https://docs.yesimbot.chat。

命令

bun install
bun run dev                 # 开发服务器 http://localhost:3000
bun run config-form:build   # 重新构建配置表单组件(tools/config-form → public/config-form)
bun run build               # 静态导出到 out/
bun run start               # 本地预览 out/
bun run types:check         # next typegen + tsc
bun run lint                # oxlint

结构

路径 作用
content/docs/ 文档正文(*.mdx)与侧边栏顺序(meta.json)
src/app/ 路由、布局、搜索接口与 OG 图片生成
src/components/ MDX 组件:Hero、ConfigPreview、搜索对话框等
src/lib/ 内容源、站点配置、中文 UI 文案、remark 插件
tools/config-form/ 配置表单组件源码,构建产物输出到 public/config-form/

写作约定

  • 页面标题写在 frontmatter 的 title,摘要写在 description。
  • 新增页面后,把文件名加入同级 meta.json 的 pages。
  • 页面之间使用相对文件路径链接,例如 [快速开始](./getting-started/quick-start.mdx);渲染时会解析成 /docs/...。
  • !!! warning "标题" 这类 MkDocs 提示块已经迁移为 <Callout type="warn" title="标题">。
  • ```yaml-config 代码块会渲染成“表单预览 / YAML”双标签面板,表单部分由 tools/config-form 构建的组件负责。

部署

main 分支的推送由 .github/workflows/docs.yml 构建并发布到 GitHub Pages。静态导出使用 trailingSlash,产物为 路由/index.html。旧版本的发布方式见多版本文档发布。

About

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages