ClassyGithub

无需部署登录，即刻访问你的定制 Github 主页、代码片段、个人博客、随笔集。

NES(Building)	Win 95(Todo)	Mac(Todo)

项目实现

• 项目基于 Github 公共 API，获取公开数据，生成你的多种主题可配置的个性主页。

• 随笔/博客或者任何其他记录性质的文档，依赖于 Github Gist，通过自定义规则配置以实现分类展示。

• 项目仅依赖于 Github 并部署在 Cloudflare，同时通过 Cloudflare 的边缘服务处理了 Github API 的限流问题。

主要技术

• 前端：Vite + Monorepo + React + Tailwind CSS

• 服务：Github API + Hono

• 部署：Cloudflare

本地运行

git clone https://github.com/Dnevend/classy-github.git # 克隆项目

pnpm install # 安装依赖

pnpm run dev # 运行默认主题

pnpm run dev:[other] # 运行其他主题

自定义配置

项目配置 classy.config.json

{
  "theme": "default",
  // 个人主页配置
  "profile": {
    "repos": {
      "visible": true,
      "showCount": 6
    },
    "cover": "https://picsum.photos/1024/576",
    "showFollowers": true,
    "showFollowing": true
  },
  // Gist 页配置
  "gists": {
    "prefix": "classy",
    "split": ".",
    "default": null,
    "type": [
      {
        "name": "blog"
      },
      {
        "name": "code"
      }
    ]
  },
  // 底部链接
  "links": [
    {
      "title": "Github",
      "href": "https://github.com/Dnevend/classy-github"
    },
    {
      "title": "Docs",
      "href": "https://docs.classygit.me"
    }
  ]
}

第三方配置

• Metrics

• Github Readme Stats

• Awesome Github Profile Readme

常见问题

• 如何实现自定义配置？

  如需实现自定义主页配置，请先 Fork 本仓库，再修改根目录下 classy.config.json 配置文件。

• 为什么我的 Gist 没有按分类展示？

  请检查你的 Gist 描述是否符合规则，默认规则为 classy.[类型].[标题]，例：classy.blog.title。

• 为什么数据没有及时更新？

  首先是 Github 接口的数据同步存在略微延迟。 其次，本项目使用了缓存以减少请求次数以获取更快的数据渲染，缓存时效为 3 分钟。

TODO

• 暗色模式

• 移动端适配

• 使用 Next.js 重构，带来更好的 SEO 效果

• 多主题

  • 经典主题
  • NES 像素主题(Building...)
  • Mac 复古主题
  • Windows 95 主题
  • 更多主题...

项目共建

提出想法&反馈问题 • 共建项目