IIIF/api

概览

GitHubGitHub

IIIF/api 是 IIIF（International Image Interoperability Framework）API 与模型规范文档的 Markdown 源码仓库。该仓库用于存储、构建和发布 IIIF 的各项技术规范，包括 Presentation API、Image API、Authentication API、Search API、AV API 以及 Annotations 等。 ## 它是什么 这是一个面向 IIIF 社区的技术文档站点源码库，使用 Jekyll 进行静态站点编译。规范文本以 Markdown 格式编写，站点的结构化数据（如成员机构、服务端实现、演示等）存放在 `_data/` 目录下的 YAML 文件中。最新 API 版本信息在 `_config.yml` 中配置。 ## 解决什么问题 它为 IIIF 规范的维护、审阅和发布提供了一套标准化的工作流。贡献者可以通过 Pull Request 或 Issue 提交规范文本的修改建议。每个分支都会自动部署到 `preview.iiif.io` 供预览，master 分支的内容会自动发布到 iiif.io 官方网站。 ## 主要能力 - **本地开发**：通过 `bundle install` 安装依赖后，运行 `rake dev` 可在本地 `http://localhost:4000` 启动开发服务器。 - **自动化测试**：结合 Rake、Grunt 和 npm 运行 CI 测试流程（`rake ci`）。 - **分支预览**：所有分支均可通过特定 URL 访问预览版本。 - **内容分离**：规范站点与 IIIF 主站点分属不同仓库，内部链接使用 Liquid 模板变量进行管理。 ## 适合谁 适合参与 IIIF 规范制定的开发者、研究人员，以及需要查阅或引用 IIIF API 技术细节的软件工程师。所有个人和组织均可参与 IIIF 社区的讨论与贡献。

Q&A

如何在本地运行这个规范站点？由 AI 生成

先执行 bundle install 安装依赖，然后运行 rake dev，即可在 http://localhost:4000 启动本地开发服务器。

如何运行项目的测试？由 AI 生成

依次执行 bundle install、npm install -g grunt-cli、npm install 安装依赖，最后运行 rake ci 即可。

如何向 IIIF 规范贡献内容？由 AI 生成

可以通过提交 Pull Request，或在 Issue 中以评论形式提出文本修改建议。贡献内容将按 CC-BY 协议由 IIIF Consortium 发布。

规范站点和 IIIF 主站点是什么关系？由 AI 生成

两者已拆分为独立仓库。规范站点源码在本仓库，主站点源码在 IIIF/website 仓库。跨站链接需使用 site.root_url 变量。