跳转到内容
Lunaria

快速入门

Lunaria 是一个专为开源项目设计的 本地化管理工具链，为维护者和贡献者提供必要的工具，以构建无缝且高效的本地化工作流程。

为什么选择 Lunaria？

作为维护者，管理本地化工作始终充满挑战：您不得不将内容移至本地化平台以放弃对内容的所有权，或无法可靠地追踪内容变更。如今，这一切已得到解决。Lunaria 通过基于 Git 的全新工作流，同时解决了上述两个问题。

对选定文件的每一次提交都会用于构建本地化仪表板，每个文件都会显示其相应的完成/过时/缺失状态。从仪表板中，维护者可以全面了解项目的本地化状态，而贡献者则可获取所需的所有信息以高效协助，包括缺失文件的链接以及需要更新的内容对应的提交列表。

快速开始

添加到您的项目

您可以使用首选的包管理器，在项目的依赖项中安装 @lunariajs/core 来将 Lunaria 添加到现有项目中：

Terminal window
npm install @lunariajs/core

然后，运行 lunaria init 来初始化 Lunaria，系统会提示您回答几个问题，并自动将答案填充到新的 lunaria.config.json 文件中：

Terminal window
npx lunaria init

根据您的项目结构，若在初始化过程中成功运行了 lunaria sync，您可能已经具备了构建首个本地化仪表板的所有条件。

如果您的 lunaria.config.json 中缺少 repository、defaultLocale、locales 或 files 字段，请访问 配置参考指南 进行设置，然后继续阅读下方说明。

构建您的首个仪表板

要构建本地化仪表板，可以运行 lunaria init 添加的 lunaria:build 脚本：

Terminal window
npm run lunaria:build

默认情况下，本地化仪表板将构建为 ./dist/lunaria/ 目录下的 index.html 文件。该文件可部署到您选择的托管平台，并与您的贡献者共享。

在浏览器中查看

构建仪表板后，您可以运行 lunaria:preview 在 http://localhost:3000/ 启动一个新的预览服务器：

Terminal window
npm run lunaria:preview

下一步

太棒了！您的项目的本地化工作现已由 Lunaria 完全跟踪！ 🌛

Lunaria 提供了多种功能供您探索，以更好地适配您的项目。以下是一些您可以按任意顺序阅读的页面，进一步了解其功能：

仪表板自定义 学习如何通过自定义样式、结构等使您的仪表板独具特色。
追踪机制 了解追踪的工作原理，以及如何在 Lunaria 中追踪内容。