Lua编程完整指南 - VitePress文档站点

这是一个使用VitePress构建的Lua编程学习文档站点，包含从基础语法到高级特性的详细文档和示例代码。

🚀 快速开始

环境要求

• Node.js 16+
• npm 或 yarn

安装依赖

npm install

开发模式

启动本地开发服务器：

npm run docs:dev

默认在 http://localhost:5173 访问

构建生产版本

npm run docs:build

构建文件将生成在 docs/.vitepress/dist 目录

预览生产版本

npm run docs:preview

📁 项目结构

lua-docs/
├── docs/                          # 文档目录
│   ├── .vitepress/               # VitePress配置
│   │   ├── config.js            # 主配置文件
│   │   └── theme/               # 自定义主题
│   │       ├── index.js         # 主题入口
│   │       └── custom.scss      # 自定义样式
│   ├── index.md                 # 首页
│   ├── README.md                # 原始README
│   └── *.md                     # 各章节文档
├── package.json                 # 项目配置
└── README.md                    # 项目说明

📚 文档内容

基础篇 (01-05)

• Lua基础介绍
• Lua数据类型
• Lua运算符
• Lua流程控制
• Lua函数

核心篇 (06-10)

• Lua字符串操作
• Lua数组和表
• Lua协程
• Lua错误处理
• Lua文件和IO操作

高级篇 (11-14)

• Lua模块与包
• Lua数据结构
• Lua面向对象编程
• Lua调试和性能优化

专题篇 (15-19)

• Lua C API
• Lua数学操作
• Lua数据库操作
• Lua系统相关操作
• Lua网络编程

🎨 特性

• ✅ 现代化设计 - 基于VitePress的现代文档站点
• ✅ 响应式布局 - 完美适配桌面和移动设备
• ✅ 深色模式 - 支持明暗主题切换
• ✅ 全文搜索 - 内置本地搜索功能
• ✅ 代码高亮 - 支持Lua语法高亮
• ✅ SCSS支持 - 使用SCSS进行样式定制
• ✅ 导航优化 - 清晰的章节导航和侧边栏
• ✅ SEO友好 - 优化的元数据和结构

🛠️ 自定义配置

修改主题色彩

编辑 docs/.vitepress/theme/custom.scss 文件中的CSS变量：

:root {
  --vp-c-brand-1: #2563eb;  // 主色调
  --vp-c-brand-2: #3b82f6;  // 辅助色
  --vp-c-brand-3: #60a5fa;  // 浅色
}

修改站点配置

编辑 docs/.vitepress/config.js 文件：

export default defineConfig({
  title: '你的站点标题',
  description: '你的站点描述',
  // 其他配置...
})

添加新页面

1. 在 docs/ 目录下创建新的 .md 文件
2. 在 docs/.vitepress/config.js 的 sidebar 配置中添加链接

📝 编写文档

Markdown扩展

VitePress支持多种Markdown扩展：

代码组

::: code-group

```lua [示例1]
print("Hello, Lua!")

local name = "World"
print("Hello, " .. name)

:::

#### 自定义容器

```markdown
::: tip 提示
这是一个提示框
:::

::: warning 警告
这是一个警告框
:::

::: danger 危险
这是一个危险提示框
:::

🚀 部署

GitHub Pages

1. 在 .github/workflows/ 目录下创建部署工作流
2. 推送代码到GitHub仓库
3. 启用GitHub Pages

Vercel

1. 连接GitHub仓库到Vercel
2. 设置构建命令：npm run docs:build
3. 设置输出目录：docs/.vitepress/dist

Netlify

1. 连接GitHub仓库到Netlify
2. 设置构建命令：npm run docs:build
3. 设置发布目录：docs/.vitepress/dist

🤝 贡献

欢迎贡献代码和改进文档！

1. Fork 这个仓库
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 打开 Pull Request

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🔗 相关链接

• VitePress官方文档
• Lua官网
• Lua参考手册

---

开始你的Lua编程之旅吧！ 🚀

📱 在线访问

文档站点部署完成后，可通过以下地址访问：

• GitHub Pages: https://pengcunfu.github.io/lua-docs/