Obsidian 插件：HTML Reader
插件名片
概述
这是一个 Obsidian 的 HTML 文件阅读器插件。可以打开.html 和.htm 文件扩展名的文档。
原文出处
下面自述文件的来源于 Readme
Readme(翻译）
下面是 obsidian-html-plugin 插件的自述翻译
Obsidian HTML 阅读器插件
这是一个为 Obsidian（https://obsidian.md）开发的插件。可以打开以 .html 和 .htm 文件扩展名结尾的文档。
如何使用
- 将 .html 或 .htm 文件放入任何已安装 obsidian-html-plugin 的 vault 文件夹中
- 单击任何 HTML 或 HTM 项目以打开它
- 阅读
从 Obsidian 安装此插件
- 转到⚙” 设置 ” ⇨ ” 社区插件 ” 选项页面，确保 ” 限制模式 ” 已关闭。
- 点击
浏览按钮打开社区插件浏览对话框。 - 搜索此插件 ”HTML Reader” 并点击相应的结果项。
- 点击
安装按钮安装此插件。 - 安装完成后，点击
启用按钮启用此插件。 - 或者，从 ” 社区插件 ” 选项页面的 ” 已安装插件 ” 列表中启用此插件 ”HTML Reader“。
手动安装插件
- 从 发布列表 中复制
main.js和manifest.json文件到你的 Vault<path>/<to>/<vaultFolder>/.obsidian/plugins/obsidian-html-plugin/目录下。 - 重新启动 Obsidian。
- 前往⚙” 设置 ” ⇨ ” 社区插件 ” 选项页面，确保 ” 限制模式 ” 已关闭，并在 ” 已安装插件 ” 列表中启用这个插件 ”HTML Reader“。
HTML 阅读器设置
- 前往⚙” 设置 ” ⇨ ” 社区插件 ” 选项页面，找到 ”HTML 阅读器” 项目的设置图标⚙，然后点击它。
- 或者，在启用后，前往⚙” 设置 ” ⇨ 在 ” 社区插件 ” 组的左侧面板底部点击 ”HTML 阅读器” 项目。
通用设置
操作模式
将此插件的操作模式设置为保护用户和应用程序。
比较
| 图像 | 样式 | 脚本编写 | DSD* | CSP# | HTML 清理 | 隔离 | |
|---|---|---|---|---|---|---|---|
| 文本模式 | 否 | 否 | 否 | 是 | 是 | 是 | 是 |
| 高限制模式 | 是[1] | 部分 | 否 | 是 | 是 | 是 | 是 |
| 平衡模式 | 是 | 是 | 否 | 是 | 是 | 是 | 是 |
| 低限制模式 | 是 | 是 | 部分[2] | 是 | 否 | 否 | 是 |
| 无限制模式 | 是 | 是 | 是[3] | 是 | 否 | 否 | 是 |
#: 内容安全策略
[1]: 外部图像源将被 CSP 阻止。
[2]: <script> 标签和外部脚本文件中的脚本代码仍无法执行。
[3]: 由于 Obsidian 的限制，外部脚本文件可能无法执行。
详细解释
-
文本模式 - 强烈建议用于来自不受信任来源的文件！该模式几乎清除了所有的视觉效果、脚本代码和样式。同时，它保留了文本部分，以便使用 HTML 布局元素阅读 HTML 文件的内容。
-
高限制模式 - 该模式适用于希望获得更高安全性的用户。它会保留自定义元素，但清除不安全的 HTML 元素以及不安全的属性及其内容。外部图像源将被 CSP 阻止，图像仅可从 HTML 文件本身中获取。
-
平衡模式 - 该模式是此插件的默认模式。它会保留所有自定义元素和 HTML 元素，但清除不安全的属性及其内容。
-
低限制模式 - 该模式不会清除任何内容，所有元素及其内容都将保留。
<script>标签内的脚本代码仍无法执行，外部脚本文件也无法执行。 -
无限制模式 - 该模式非常危险，可能导致 Obsidian 应用崩溃，OBSIDIAN 和此插件对切换到此模式不承担任何责任或责任 。它不会清除任何内容，所有元素及其内容都将保留。Obsidian 应用本身可能会进行一些调整。由于 Obsidian 的限制，外部脚本文件可能无法执行。强烈建议在正常使用情况下不要切换到此模式。
如果切换到此模式后遇到问题，建议执行以下恢复步骤：
- 返回到之前可以正常打开的文件。
- 删除或将打开错误的文件移动到回收站。否则，Obsidian 在重新启动后仍会打开它。
- 返回到此设置页面，切换到另一个操作模式。
有时您仍然无法看到想要的内容，那么您应该检查 HTML 文件的内容。此模式只是保留内容（仅调整外部链接锚标签，使其在默认浏览器窗口中打开），但文件可能具有一些自包含的安全保护机制（例如 CSP），它们会阻止某些内容以避免 XSS 攻击。如果您在 HTML 文件中找到类似
<meta http-equiv="Content-Security-Policy" />的内容，这意味着该文件受到 CSP 机制的保护。您可以：- 手动修改或删除 CSP
<meta>标签。 - 更改原始网页保存应用的捕获设置，以禁用 CSP 或其他设置，并重新保存网页。
术语解释
本节将尝试更详细地解释操作模式中使用的一些术语。您可以忽略一些非粗体字体的术语（它们是技术术语）。
- 样式 - 指 HTML CSS 样式。它们几乎是安全的，但 CSS 注入或 CSS 键盘记录器可能会窃取一些信息，因此在 平衡模式 和 高限制模式 下，一些用户 交互元素 将被禁用。
- 脚本编写 - 指 Javascript 和非常危险的。即使在 低限制模式 和 无限制模式 下，一些脚本代码也可以执行，但这并不意味着它们可以正常工作。脚本代码越复杂，它们正常工作的机会就越小。如果要使脚本代码按照您的意愿工作，您应该重写它们和相关模块，以满足 Obsidian 平台的要求，因为 Obsidian 平台与普通浏览器之间存在许多不同之处。
- DSD - 指 声明式 Shadow DOM。
- CSP - 指 内容安全策略。它提供一些“绑定操作指令”，告诉 Obsidian 如何处理某些资源。它的规则与普通浏览器和网站使用的规则不同，
'self'设置对 Obsidian 来说几乎没有意义。 - HTML 清理 - 当加载 HTML 文件时，此机制会物理上清除不安全的内容，并且三种模式之间有不同的配置。清理配置是渐进的，并且可能随版本迭代而改变。如果您认为某些标签或属性不应该被清理，请在 问题页面 中创建一个新问题，让我知道。
- 隔离 - HTML 文件的 CSS 样式应与 Obsidian 的其他部分隔离开来，否则 Obsidian 的布局可能会被打乱，字体可能变得丑陋。CSS 隔离的缺点可能导致某些 CSS 效果丢失，例如
:target伪类事件将永远不会触发。您可以从 CSS 隔离 维基页面获取更多详细信息。 - 自定义元素 - 指 HTML 标签，例如
<xxx-yyy>，它们通常与相关的 JavaScript 代码一起使用。因此，在禁止脚本编写时，自定义 HTML 标签几乎无用，只会充当纯容器。
背景颜色
强制设置 HTML 的<body> 元素的背景颜色。
快捷键和触摸手势设置
几乎所有的键盘快捷键都来自 Obsidian 的全局快捷键设置，因此您应该通过⚙” 设置 ” ⇨ ” 快捷键 ” 选项页面来修改它们。
这意味着该插件不会为键盘快捷键设计任何新的配置界面。它只会以只读模式显示相应快捷键的前两个设置。
搜索文档文本
搜索当前文件。
放大文档
放大当前文件。
缩小文档
缩小当前文件。
重置文档缩放
重置当前文件的缩放。
快速文档缩放
使用 Ctrl + 鼠标滚轮进行文档缩放（放大：↑，缩小：↓），或使用触摸板/触摸屏/触摸面板的双指捏合缩放手势（放大：← →，缩小：→ ←）。
更多选项
在打开 HTML 文件后，选项卡右上角的三个点⋮“更多选项”菜单图标将添加一些菜单项。
找到…
打开搜索栏。
放大
放大当前文件。
缩小
缩小当前文件。
重置缩放
重置当前文件的缩放。
如何从源代码构建此插件
- 将此项目克隆到您的系统。
- 在本地项目文件夹下，键入命令
npm i来安装必要的包。（您需要在开发环境中安装 Node.js） - 然后运行
npm run dev来构建插件文件。
已知问题
- 无法查看本地图像文件，如
<img src="./image1.jpg" />或<img src="file:///C:/image1.jpg" />- 这是 Obsidian 的限制，它不允许通过 HTML 代码直接访问本地文件。
- 一种可能的解决方法是使用专用的浏览器扩展（如 ”SingleFile“）将 HTML 文件重新保存为完整的 HTML 文件，它可以将整个页面（包括 CSS、图像、字体、框架等）保存为单个 HTML 文件。在获得完整的 HTML 文件后，将其放入已安装 obsidian-html-plugin 的 vault 文件夹中，然后打开它，您将看到所有图像。
- 另一种解决方法是手动将
src属性的前缀字符串添加为app://local/或app://local//（参考 ”Allow embed of Local images using”)。
- 打开某些.html 文件后，它们看起来像空白页面，无法看到原始内容。
- 实际上，在当前版本（1.0.4 之后），此插件只能处理某些类型的 HTML 文件：
- 标准的 HTML5 文件
- 使用 SingleFileZ 创建的压缩的类 HTML 文件
- 因此，当打开不受支持的文件格式时，此插件会通知相关消息或显示几乎空白的页面。
- ” 使用
.html和.htm文件扩展名打开文档 ” 是针对没有技术背景的最终用户编写的描述。这并不意味着此插件可以打开所有带有.html 或.htm 文件扩展名的文件，特别是当文件实际上是其他文档类型但重命名为.html 或.htm 文件扩展名时。 - 如果要打开 ePub 文件，您应该安装 “ePub Reader” 插件来打开它，而不是将其重命名为 xxx.html 然后询问为什么此插件无法打开它。
- 实际上，在当前版本（1.0.4 之后），此插件只能处理某些类型的 HTML 文件：
- 一些 HTML 元素消失了
- 这可能是由以下原因引起的：
- 被 HTML 消毒机制移除
- 被隐藏或变得不可见
- 您可以尝试切换 操作模式 到不同的模式，看看消失的 HTML 元素是否变得可见。如果是，您可以在 Issues页面 上创建一个新问题，让我知道，我会与您讨论。
- 如果在切换到较不受限制的模式后仍然看不到消失的 HTML 元素，那就意味着它们被隐藏或变得不可见。当 HTML 元素使用一些高级功能（如 ”声明式Shadow DOM“）时，这种情况经常发生（此功能在 1.0.4 版本之后得到支持），而此插件或 Obsidian 尚未支持。然后，您可以在 Issues页面 上创建一个新问题，让我知道，我会与您讨论。
- 这可能是由以下原因引起的：
- 几乎所有的脚本代码都无法工作
- 在移动平台上无法使用鼠标滚轮进行缩放
- 似乎 Obsidian 应用程序在移动平台上阻止了某些操作，因此这些操作无法正常工作。
- 您可以在触摸屏上使用双指捏合缩放手势进行缩放。
- 您可以使用 ”更多选项” 菜单项进行缩放。
- 移动平台上缩放相关的热键设置消失了
- Obsidian 的移动版本不提供这些设置，因此此插件也不提供它们。
- 搜索结果的演示样式与 Markdown 文档不同
- HTML 文件中有许多标签/元素，某些搜索结果可能跨越标签并重叠在一起。因此，此插件使用块标记样式（背景色高亮显示）而不是大纲样式。
