本仓库是一个基于 Docusaurus 的文档站点,用于沉淀 Lua 应用开发过程中整理的模块接口与示例(如 lvgl / dataman / animengine 等)。
同时集成 Tauri,可将文档站点打包为离线桌面应用(Windows NSIS)。
- Node.js
>= 20(见package.json) - (可选,桌面版)Rust 工具链 + Tauri 依赖
npm ci
npm run start默认会启动开发服务器(通常为 http://localhost:3000)。
npm run build产物输出到 build/。
需要本机已配置 Rust/Tauri 构建环境。
npx tauri devnpx tauri build绿色版就是只分发单个 exe(不生成 NSIS 安装包):
npm run tauri:portable- 可执行文件位置:
src-tauri/target/release/app.exe - 你可以把
app.exe重命名后直接压缩成 zip 分发 - 说明:即使是绿色版,运行时仍可能在用户目录写入缓存/配置(取决于 Tauri/WebView2)
docs/:文档内容(Markdown/MDX)sidebars.ts:文档侧边栏结构docusaurus.config.ts:站点配置(标题、主题、路由等)src-tauri/:Tauri 应用配置与 Rust 端
- 新增/修改文档:在
docs/下编辑,并在sidebars.ts中挂载导航 - 建议优先阅读:
docs/intro/conventions.md