mirador

️该项目适用于 Mirador 3，即 Mirador 的最新版本。对于 Mirador 2，请参阅 ProjectMirador/mirador2 或 Mirador 2 wiki 上的旧文档。请注意，社区的重点是 Mirador 3，不太可能接受 Pull 请求或为 Mirador 2 提供支持。

米拉多尔

对于 Mirador 用户

您可以通过重新混合 mirador-start Glitch 来快速使用和配置 Mirador。

我们建议使用 JavaScript 包管理器（例如 npm 或 YARN）安装 Mirador。

$ npm install mirador 

# or

$ yarn add mirador

如果您有兴趣将 Mirador 与插件集成到您的项目中，我们建议使用 webpack 或 Parcel 来集成 es 版本的软件包。示例如下：

https://github.com/ProjectMirador/mirador-integration

如果您只想将 Mirador 嵌入 HTML 页面而不进行进一步自定义，请包含 Mirador UMD 版本：

 <script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>

有关嵌入 Mirador 的更多示例，请访问 https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript。

向 Mirador 添加翻译

有关添加翻译的帮助，请参阅 src/locales/README.md

在本地运行 Mirador 进行开发

Mirador本地开发需要安装nodejs。

1. 运行npm install以安装依赖项。

启动项目

$ npm start

然后导航到http://127.0.0.1:4444/

实例化 Mirador

 var miradorInstance = Mirador . viewer ( {
  id : 'mirador' // id selector where Mirador should be instantiated
} ) ;

> miradorInstance
{ actions , store }

示例操作

添加一个窗口：

 store . dispatch ( actions . addWindow ( ) ) ;

要聚焦窗口运行：

 store . dispatch ( actions . focusWindow ( 'window-1' ) )

检查当前状态

 store . getState ( ) 

运行测试

$ npm test # For headless CI=true npm test

或持续观看源文件

$ npm run test:watch

检查项目

$ npm run lint

调试

本地实例

以下浏览器扩展对于调试 Mirador 的本地开发实例非常有用：

• React 开发工具
• Redux 开发工具

测试套件

要调试测试套件，请运行：

$ npm run test:debug

然后启动 Nodejs 检查器客户端并设置一些断点。请参阅此处，了解使用 Chrome DevTools 进行调试的指南。