快速上手

环境要求

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

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

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

快速上手

基于 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）来浏览你的网站

下一步

• 修改你网站的基础配置
• 配置你网站的导航栏和侧边栏
• 为你的网站添加文章（文档待补充，请参考 src/posts/ 目录下的示例）
• 使用其他拓展功能
• 使用ShokaX MDX 扩展美化你的文章

更新主题

提示

请务必经常更新 ShokaX Astro，ShokaX Astro 目前仍处于积极开发阶段中，会经常添加新功能和实施改进

在 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 的使用方法和配置选项。