⭐ StarShineMC 文档网站

基于 Docusaurus 构建的 StarShineMC 服务器玩家文档网站。

---

🚀 快速开始

安装依赖

npm install

启动开发服务器

npm start

开发服务器将在 http://localhost:3000/ 启动，支持热重载。

构建生产版本

npm run build

构建产物将生成在 build/ 目录。

预览生产版本

npm run serve

---

📁 项目结构

starshine-docs/
├── docs/                    # 文档目录
│   ├── intro.mdx           # 首页介绍
│   ├── faq.mdx             # 常见问题
│   ├── commands/            # 指令文档
│   │   ├── basic.mdx       # 基础传送指令
│   │   ├── cmi.mdx         # 经济系统
│   │   ├── region.mdx      # 领地系统
│   │   ├── world.mdx       # 多世界系统
│   │   ├── skin.mdx        # 皮肤系统
│   │   └── utils.mdx       # 其他常用指令
│   └── bedrock/             # 基岩版文档
│       └── connect.mdx     # 基岩版连接指南
├── src/
│   ├── components/          # React 组件
│   ├── pages/               # 页面组件
│   └── css/                 # 样式文件
├── static/                  # 静态资源
├── docusaurus.config.ts     # Docusaurus 配置
└── sidebars.ts              # 侧边栏配置

---

✏️ 编辑文档

所有文档都使用 MDX 格式编写，支持 Markdown 语法和 JSX 组件。

添加新文档

1. 在 docs/ 目录下创建新的 .mdx 文件
2. 在 sidebars.ts 中添加文档路径

文档 frontmatter

每个文档文件顶部需要添加 frontmatter：

---
sidebar_position: 1
title: 文档标题
slug: /custom-url
---

---

🎨 自定义主题

修改颜色

编辑 src/css/custom.css 文件：

:root {
  --ifm-color-primary: #2e8555;
  --ifm-color-primary-dark: #29784c;
  --ifm-color-primary-darker: #277148;
  --ifm-color-primary-darkest: #205d3b;
  --ifm-color-primary-light: #33925d;
  --ifm-color-primary-lighter: #359962;
  --ifm-color-primary-lightest: #3cad6e;
}

修改导航栏

编辑 docusaurus.config.ts 中的 navbar 配置。

---

🚢 部署

GitHub Pages

npm run deploy

其他平台

构建 build/ 目录后，将静态文件部署到任何静态托管服务。

---

📝 更新日志

• 2026-06-13：初始化项目，添加玩家指令文档

---

📄 许可证

MIT License © 2026 StarShineMC