月球波

月球波是一个从 Lua 源代码注释中生成文档的命令行工具。

此仓库包含三个项目

• 月球波提取器，一个解析 Lua 文件并将其文档作为 JSON 提取的 Rust 程序
• 一个用于 Docusaurus 的插件，使用 React 编写，可以直观地显示 JSON 文档
• 月球波 CLI，允许您使用提取器和 Docusaurus 插件，而无需了解它们的工作原理。

主要功能

• 易于使用：您可以在 Lua 代码中添加少量注释，即可轻松生成网站。
• 广泛的验证系统，可以捕获不合理的错误。
• 从您的文档注释生成 JSON，可以被许多不同的工具使用。
• 简单的文档注释格式，便于在编辑代码时直接阅读。

演示

查看 roblox-lua-promise 文档。此网站完全由月球波生成！

名称

Lua 是月球。月球是你的代码。就像你的代码影响其文档一样，月球影响着海洋中的波浪。所以.. 月球波！

文档

查看文档网站

开发和贡献

要求

• Node.js 18+
• Rust 1.54.0 和 Cargo

1. 克隆此仓库
2. 在 cli 目录下，运行 npm i，npm run tsc 和 npm link
3. 在 docusaurus-plugin-moonwave 目录下，运行 npm i
4. 在 extractor 中，运行 cargo install --path . --locked
5. 在 cli 中，运行 npm run dev
6. 在另一个终端中，导航到您想要测试的项目目录，并运行 MOONWAVE_DEV=1 moonwave dev

现在您应该能够更改 moonwave 文件夹中的文件，并且您的开发网站应该会实时重新加载。如果不行，请按 Ctrl+C 停止 moonwave dev 终端并重新启动它。如果问题仍然存在，请尝试添加 - 标志来重新安装所有依赖项。