Skip to content

Gawg-AI/OpenEnerOS-Web

Repository files navigation

EnerOS 官方网站

English | 中文


EnerOS 项目的官方网站与文档系统,基于 Astro 5.18 + Tailwind CSS 3.4 构建,部署于 GitHub Pages。

技术栈

  • 框架: Astro 5.18 (静态站点生成)
  • 样式: Tailwind CSS 3.4 + CSS 变量 (暗色模式)
  • 搜索: Pagefind 1.5 (静态全文搜索)
  • 部署: GitHub Pages + GitHub Actions
  • 内容: Astro Content Collections (类型安全的 Markdown 管理)

网站结构

  • 首页: 产品展示 (Hero / 新闻 / 能力 / 架构 / 场景 / 产品矩阵 / 生态 / 关于)
  • 文档系统: 73 页文档 (快速开始 / 核心概念 / 架构 / 能力 / API / Crate 索引 / 教程 / 合规 / ADR / 贡献)
  • 搜索: ⌘K / Ctrl+K / / 快捷键触发全文搜索

本地开发

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本 (含 Pagefind 索引)
npm run build

# 预览构建结果
npm run preview

目录结构

eneros-web/
├── public/                  # 静态资源 (favicon, robots.txt)
├── src/
│   ├── components/          # UI 组件
│   │   ├── docs/            # 文档系统组件 (Sidebar, Search, Breadcrumb, PrevNext)
│   │   ├── home/            # 首页组件 (Hero, Capabilities, Architecture, ...)
│   │   ├── layout/          # 布局组件 (Header, Footer)
│   │   ├── ui/              # 基础 UI (Button, Card, Badge, Icon, ThemeToggle)
│   │   └── SEO.astro        # SEO 元标签
│   ├── config/              # 站点配置 (导航, 能力, 场景, Crate 索引, 文档侧边栏)
│   ├── content/             # Markdown 内容
│   │   ├── docs/            # 73 篇文档
│   │   └── news/            # 6 条版本发布新闻
│   ├── layouts/             # 布局 (BaseLayout, DocsLayout)
│   ├── pages/               # 路由页面 (index, docs/[...slug])
│   ├── styles/              # 全局样式
│   └── content.config.ts    # Content Collections 配置
├── astro.config.mjs         # Astro 配置 (site, base, integrations)
├── tailwind.config.mjs      # Tailwind 配置 (颜色系统, 字体, 动画)
└── package.json

部署

网站通过 GitHub Actions 自动部署到 GitHub Pages 自定义域名:

暗色模式

支持系统跟随 + 手动切换 (localStorage 持久化),在 <head> 内联脚本防止 FOUC。

搜索

文档系统使用 Pagefind 静态搜索:

  • 构建时索引所有文档页面
  • 支持 ⌘K (macOS) / Ctrl+K (Windows) / / 快捷键
  • 中文分词 (zh-cn)

许可证

MIT License - 与主项目 EnerOS 一致

Releases

Packages

Contributors

Languages