👨‍💻 niltor 📆 2026-08-17 13:21

配置文件

EasyDocs 读取一个 JSON 配置文件。下面的示例同时包含站点、文档和产品配置：

{
  "Name": "我的文档站点",
  "Description": "一个静态文档站点",
  "AuthorName": "Ater",
  "ContetPath": "./Content",
  "OutputPath": "./WebSite",
  "BaseHref": "/",
  "Domain": "https://example.com",
  "RepositoryUrl": "https://github.com/example/docs",
  "Branch": "main",
  "Icon": "favicon.ico",
  "DocInfos": [
    {
      "Name": "EasyDocs",
      "Languages": ["en-US", "zh-CN"],
      "Versions": ["2.0"]
    }
  ],
  "ProductInfos": [
    {
      "Name": "MyProduct",
      "Description": "一个多语言产品指南",
      "Logo": "logo.svg",
      "Languages": ["en-US", "zh-CN"],
      "DefaultLanguage": "zh-CN"
    }
  ]
}

重要属性

ContetPath 为了兼容已有配置，故意保留这个拼写错误，不要直接改成 ContentPath。
OutputPath 是生成的静态站点目录。
BaseHref 必须以 / 结尾；部署在域名根路径时使用 /。
Domain 可选，用于生成页面 canonical 和 sitemap.xml。
RepositoryUrl 与 Branch 用于生成文档编辑链接。
DocInfos 声明文档名称、语言和版本，每一项都必须有对应目录。
ProductInfos 声明产品和语言，DefaultLanguage 必须存在于 Languages 中，并且对应目录必须存在。

JSON 属性名称区分大小写，语言和版本目录名称应与配置值保持一致。

In this article

重要属性