快速上手

环境要求

要使用 ShokaX Astro，你需要安装：

Bun 作为 JS 运行时
Git 作为项目克隆和版本管理工具

如果你没有听说过这些程序或还没有安装，请转到侧边栏中的“术语表”部分来查看其介绍和安装指导

快速上手

使用 HyC 进行交互式安装（推荐）

bun install @hyacine/cli -g

hyc -V
# 如果有输出，证明安装成功

# 选一个好位置
mkdir astro-blog-shokax # 也可以是别的名字，或者使用文件管理器自行创建一个空文件夹
cd astro-blog-shokax # 切换到你准备安装 ShokaX 的文件夹

hyc serve --setup
# 安装程序会自动启动，输出类似于：
# ✅ 服务已在 3789 端口开放
# 🔐 认证码（高敏感，请勿泄露）: <16位的认证码>
# 🌐 请前往官方控制台进行操作：https://hyc.kaitaku.xyz/
# 浏览器打开提示的官方控制台，即------^^^^^^^^^^^^^^^^^
# 在控制台中输入16位认证码，随后进入部署流程

随后，按照网页的指导进行安装即可，网页会：

自动确认依赖安装是否正确
自动克隆 github 储存库，并根据网络情况自动使用镜像源和加速源
自动安装 Bun 依赖，并根据网络情况自动使用镜像源

结束后，网页会提示你执行 HyC 的初始化工作并重启服务器到正常模式

基于 Git 的安装

打开你系统中的命令行工具，然后运行：

# 记得先切换到你准备放置这个 Blog 的地方

git clone https://github.com/theme-shoka-x/astro-blog-shokax.git

cd ./astro-blog-shokax

bun install
bun run dev

开发服务器会自动启动，你可以访问提示的网址（通常为http://localhost:4321）来浏览你的网站

下一步

修改你网站的基础配置
配置你网站的导航栏和侧边栏
为你的网站添加文章
使用其他拓展功能
使用ShokaX MDX 扩展美化你的文章

更新主题

在 ShokaX Astro 发布新版本时，你可以通过 Git 更新主题：

git pull

bun install
# 更新完成

如果想个性化和定制化 ShokaX，建议你 Fork 我们的仓库，这能极大降低后续更新的难度，方法可见左侧的“最佳实践”栏目（此部分正在编写中，暂不可用）

为 AI 助手使用文档

ShokaX Astro 文档提供了专门为 AI 助手（如 Claude、ChatGPT）优化的文档端点：

/llms.txt - 提供文档目录和链接列表，适合快速浏览文档结构
/llms-full.txt - 提供完整的文档内容，适合深度查询和详细问题

如果你正在使用 AI 编码助手（如 GitHub Copilot、Cursor 等），可以提供这些链接让 AI 更好地理解 ShokaX Astro 的使用方法和配置选项。