book-catalog.md 2.0 KB

正式书库目录说明

部署到正式环境后,网站会优先读取:

storage/books/catalog.json

如果这个文件不存在,网站才会回退到代码里的演示书数据。

推荐结构

每一本书建议按下面的结构组织:

  1. 设定资料分区
  2. 正文分卷分区

也就是:

  • 世界观设定
  • 人物档案
  • 势力组织
  • 时间线
  • 地图地点
  • 正文 第一卷
  • 正文 第二卷

这样目录里就能同时看到资料库和小说正文,而且顺序稳定,不会打乱。

顶层字段

每本书需要这些字段:

  • id
  • title
  • author
  • category
  • description
  • wordCount
  • coverStyle
  • sections

sections 字段

sections 是分区数组,每个分区需要:

  • id
  • title
  • kind
  • order
  • entries

说明:

  • kind 只能是:
    • lore:资料
    • novel:正文
  • order 用来控制目录顺序
    • 资料建议从 1 开始
    • 正文建议从 100 开始

entries 字段

每个分区下面的 entries 是具体条目,每条需要:

  • id
  • title
  • kind
  • order
  • content

说明:

  • kind 要和所属分区一致
  • order 控制分区内顺序
  • content 是字符串数组,每一项就是一段内容

推荐排序规则

为了避免目录混乱,建议固定按下面方式编号:

  • 资料分区:
    • 世界观设定:order: 1
    • 人物档案:order: 2
    • 势力组织:order: 3
    • 时间线:order: 4
  • 正文分区:
    • 第一卷:order: 100
    • 第二卷:order: 200
    • 第三卷:order: 300

这样即使后面继续补资料,也不会把正文顺序打乱。

示例文件

完整示例见:

book-catalog.example.json

正式使用建议

正式部署时建议:

  1. 只把正式书数据放到 storage/books/catalog.json
  2. 不要直接改代码里的 demo
  3. ops 或内容维护流程负责更新 storage/books/catalog.json
  4. 更新书库后重启服务或走热更新刷新内容