迪拉熊Bot 官方文档网站

📖 项目简介

迪拉熊Bot的官方文档网站，部署于 https://www.dxkuma.bot。

基于 Astro 框架和 Starlight 文档主题构建，为用户提供安装指南、功能介绍、指令大全、更新日志和贡献指南等内容。

🛠️ 技术栈

• 核心框架：Astro
• 文档主题：@astrojs/starlight
• Markdown处理器：@astrojs/markdown-satteri
• 字体：@fontsource-variable/noto-sans-sc
• 包管理：Bun
• 增强插件：lucode-starlight（页脚自定义等）
• 部署：GitHub Pages

📦 快速开始

1. 环境要求

• Bun 包管理器

2. 获取源码并安装依赖

git clone <your-repo-url>/dxkuma-website.git
cd dxkuma-website
bun install

3. 本地开发

bun run dev

启动后访问 http://localhost:4321 即可预览文档。

4. 构建与预览

# 构建生产版本，产物输出到 dist/ 目录
bun run build

# 预览构建结果
bun run preview

📁 项目结构

├── src/
│   ├── content/
│   │   └── docs/              # 文档内容（MDX）
│   │       ├── user-guide/          # 用户指南
│   │       ├── commands/            # 指令大全
│   │       ├── changelog/           # 更新日志
│   │       ├── collaborator-guide/  # 贡献指南
│   │       ├── index.mdx            # 首页
│   │       └── credits.mdx          # 成员名单
│   ├── components/            # 自定义组件
│   └── styles/                # 自定义样式
├── public/                    # 静态资源
├── astro.config.mjs           # Astro 配置（含侧边栏定义）
└── package.json

📝 编写文档

文档内容位于 src/content/docs/ 目录下，采用 Markdown/MDX 格式编写。网站导航结构（侧边栏）在 astro.config.mjs 中配置。

🤝 贡献

欢迎为迪拉熊Bot的文档做出贡献。你可以通过以下方式参与：

1. 在 Codeberg 上提交 Issue 或 Pull Request
2. 点击任意页面右上角的"编辑此页"链接直接编辑

📄 开源协议

本站内容采用 署名—相同方式共享 4.0 协议国际版 (CC BY-SA 4.0) 授权。详细信息请参阅 LICENSE 文件。