开发指南

获取数据库内容

推荐使用 Github Release 或 GitHub 镜像，发布的 JSON 对象格式可参照 Editor。

本项目使用持续集成进行发布，每次发布包含 15 个文件（5 中缀 * 3 后缀），各文件的内容如下所述：

• 后缀：

  • *.json 是 JSON 表示的数据库；
  • *.json.gz 是其 gzip 压缩后的版本；
  • *.js 是用于 JSONP 调用的脚本，回调函数名为 load_ehtagtranslation_db_${中缀}，由于 GitHub 的跨域限制，浏览器端仅能使用此方案。

• 中缀：

  • *.raw.* 包含了 MarkDown 版本的名称、描述和外部链接；
  • *.html.* 包含了渲染为 HTML 的名称、描述和外部链接；
  • *.text.* 包含了去除图片和链接的的名称、描述和外部链接；
  • *.ast.* 包含了 JSON 表示的 MarkDown 的语法树结构，格式可参照 Editor；
  • *.full.* 包含了以上所有信息。

以下为 node 代码示例。

const fetch = require("node-fetch");
const db = await (
  await fetch(
    "https://github.com/EhTagTranslation/Database/releases/latest/download/db.html.json"
  )
).json();

也可以使用 git 或 Github API 直接获取 MarkDown 并自行解析，此时需要注意 version 文件表明的数据库结构版本。

编辑数据库内容

请参考 EhTag Editor 及本项目参与翻译指南。