手动安装

本指南将引导您手动安装和配置 Lunaria 到现有项目中。

提示

如需简化、通过 CLI 引导的设置，请参考 入门指南的“快速开始”部分。

1. 添加 @lunariajs/core 包

Lunaria 通过 npm 仓库中的 @lunariajs/core 包发布。请在项目根目录中运行以下命令，将其添加到您的项目中：

npm

npm install @lunariajs/core

pnpm

pnpm install @lunariajs/core

Yarn

yarn add @lunariajs/core

然后，在您的 package.json 的 scripts 字段中添加以下 lunaria 命令：

package.json

"scripts": {
  "dev": "astro dev",
  "build": "astro build",
  "preview": "astro preview",
  "lunaria:build": "lunaria build",
  "lunaria:preview": "lunaria preview",
}

2. 创建 lunaria.config.json

Lunaria 使用 lunaria.config.json 进行配置。此文件是必需的，以便 Lunaria 了解您的仓库结构以及需要追踪的内容。

lunaria.config.json

{
  "$schema": "./node_modules/@lunariajs/core/config.schema.json"
}

提示

@lunariajs/core 随附一个 JSON Schema，您可以通过可选的 $schema 属性引用它，以在代码编辑器中启用 IntelliSense 支持。

3. 配置包

在生成第一个本地化仪表板之前，您必须设置 lunaria.config.json 文件中的 repository、defaultLocale 和 locales 字段。

以下示例将 Lunaria 配置为在一个示例项目中追踪英文和葡萄牙语的 Markdown/MDX 内容，该项目托管在 https://github.com/me/cool-project/：

lunaria.config.json

{
  "$schema": "./node_modules/@lunariajs/core/config.schema.json",
  "repository": {
    "name": "me/cool-docs"
  },
  "files": [
    {
      "location": "content/**/*.md",
      "pattern": "content/@lang/@path",
      "type": "universal"
    }
  ],
  "defaultLocale": {
    "label": "英语",
    "lang": "en"
  },
  "locales": [
    {
      "label": "葡萄牙语",
      "lang": "pt"
    }
  ]
}

详细了解所有可用选项，请参阅 配置参考指南。

提示

访问 Lunaria 仓库的示例目录，查看不同框架和项目类型的配置示例。

4. 下一步

成功！您现在已经准备好在项目中使用 Lunaria 了！

如果您已完整遵循本指南，可以直接跳转至 构建您的第一个仪表板，学习如何生成本地化仪表板、在浏览器中查看，并了解我们的推荐下一步操作。