docs.breezewiki.com 暂未发现付费内容

docs.breezewiki.com 是 BreezeWiki 的官方文档站点，用来集中说明 BreezeWiki 的入口链接、自动重定向方案、问题反馈渠道、部署运行方式、配置项以及开发相关内容。它面向两类人：想使用 BreezeWiki 的普通用户，以及想自行部署或参与开发的开发者。如果你只是想找一个能访问的 BreezeWiki 实例，看“Links”和“Automatic Redirection”两节即可；如果你要自己跑一份服务，则需要看“Running”“Configuration”“Developing”这几节。

文档覆盖的主要内容

从页面目录看，文档按使用到开发的顺序组织，共六个部分：

• Links：官方站点、镜像站（Mirrors）、Onion 镜像（Tor 隐藏服务）的地址列表。
• Automatic Redirection：让浏览器自动从 Fandom 跳转到 BreezeWiki 的各种方案。
• Reporting Bugs：如何提交问题报告，以及其他沟通渠道。
• Running：如何运行 BreezeWiki，包括编译好的可执行文件、源码、Docker 三种方式，以及更新源码和资源占用说明。
• Configuration：必填选项、详细选项、配置文件与环境变量两种配置形式。
• Developing：面向二次开发，涉及 Racket 语言、项目文件结构、Fandom 接口端点、HTML 树变换、编程与测试。

普通用户会用到哪几节

如果你只是访问者，重点在两节：

1. Links 提供可用的官方地址、镜像地址和 Onion 地址。镜像的存在意味着某个域名不可用时可以换一个。
2. Automatic Redirection 给出自动跳转的具体做法，文档列出的方案包括：
   • 浏览器扩展 Indie Wiki Buddy
   • iPhone 上的重定向设置
   • 浏览器扩展 Redirector
   • 浏览器扩展 Violentmonkey
   • 浏览器扩展 LibRedirect

这些方案的区别在于实现层次：有的是现成的百科跳转扩展，有的是通用重定向规则工具，有的靠用户脚本。选择时看你的浏览器平台和是否愿意装扩展即可。

自建或开发时会用到哪几节

• Running 说明三种启动路径：直接运行编译好的可执行文件、从源码运行、用 Docker 运行；另外包含源码更新方法和资源占用情况，便于判断机器是否够用。
• Configuration 区分必填项与详细选项，并给出配置文件（含示例与格式）和环境变量（含示例）两种写法，部署时按其中一种填即可。
• Developing 面向改代码的人，涉及 Racket 语言环境、项目文件、Fandom 端点、HTML 树变换、编程约定和测试方式。

遇到问题怎么反馈

文档的 Reporting Bugs 一节分两部分：一是“Actually sending a report”，即实际提交报告的流程；二是“Other communication channels”，即其他沟通渠道。需要报 bug 时按这一节走，而不是在文档里找联系方式。

使用建议

• 只想访问：先看 Links 里的官方地址，不通再试镜像或 Onion 地址。
• 想省去每次手动跳转：从 Automatic Redirection 里挑一个匹配你浏览器的方案。
• 想自己部署：按 Running 选一种运行方式，再对照 Configuration 补齐必填项。
• 想改代码：从 Developing 入手，先确认 Racket 环境和测试方式。

BreezeWiki 文档里专门设有 Reporting Bugs（报告问题） 章节，并分成两部分：Actually sending a report（实际提交报告） 和 Other communication channels（其他沟通渠道）。也就是说，报告问题有正式入口，也有备用渠道；如果你在自动重定向、镜像访问或自建实例中遇到异常，按这两条路径走即可。

先确认问题类型

报告前先判断问题属于哪一类，能帮你选对渠道、也方便维护者定位：

提交报告的实际步骤

文档把“真正把报告发出去”单独列为一节，说明这一步是重点。可以按下面的顺序操作：

1. 先复现问题：确认问题能稳定出现，记录触发条件（访问的页面、使用的镜像、浏览器或扩展版本）。
2. 对照文档自查：如果是重定向问题，先看 Automatic Redirection；如果是自建实例，先看 Running 和 Configuration，排除配置遗漏。
3. 整理最小信息：包括问题现象、复现步骤、预期结果、实际结果，以及你使用的入口（官方站、镜像还是本地实例）。
4. 通过正式渠道提交：按 Reporting Bugs 章节给出的方式发送报告。
5. 等待或跟进：如果长时间没有回应，再考虑使用其他沟通渠道。

其他沟通渠道

文档在“Actually sending a report”之外，还单列了 Other communication channels。这意味着正式提交之外还有补充联系方式，适合以下情况：

• 不确定问题是否算 bug，想先问一下；
• 报告已经提交，但需要补充信息或跟进；
• 想反馈镜像可用性、重定向规则等偏使用层面的问题。

具体渠道名称和入口以文档页面上的 Reporting Bugs 章节为准，建议直接打开该章节查看最新列表。

常见卡点

• 只描述现象，没有复现步骤：维护者难以定位，报告容易被搁置。
• 把配置问题当成 bug：自建实例启动失败，很多时候是 Required options 没填或环境变量写错，先查 Configuration 更高效。
• 重定向没生效就报 bug：先确认浏览器扩展（如 Indie Wiki Buddy、Redirector、Violentmonkey、LibRedirect）是否安装并启用，再看 Automatic Redirection 章节的对应说明。
• 镜像问题没写清是哪一个：BreezeWiki 有官方站、多个 Mirrors 和 Onion Mirrors，报告时注明具体地址能省一轮沟通。

一句话结论

遇到 BreezeWiki 的问题，先按类型自查文档对应章节，再通过 Reporting Bugs 里的正式方式提交；正式渠道之外，还可以使用 Other communication channels 补充沟通。

BreezeWiki 可以自行部署，文档给出的运行方式有三种：运行编译好的可执行文件、从源码运行、用 Docker 运行。选择哪一种取决于你手上有没有现成的二进制、是否愿意安装 Racket 工具链，以及是否习惯用容器管理服务。三种方式跑起来之后，配置都通过同一套选项完成——必需选项、详细选项，可以用配置文件，也可以用环境变量传入。

运行方式

运行编译好的可执行文件

适合不想碰源码和构建工具的情况。拿到对应平台的可执行文件后直接启动即可，不需要额外安装开发环境。文档把这一节和「从源码运行」并列，说明它是官方认可的常规路径之一。

从源码运行

需要先准备好源码运行所需的语言环境（文档在「Developing BreezeWiki」一节里专门讲了 Racket，说明源码运行依赖 Racket 工具链）。流程上分两步：先获取源码，再启动；后续如果上游有更新，文档单独给了「更新源码」的说明，按那一节操作即可。

用 Docker 运行

适合希望把依赖和运行环境一起打包、避免在宿主机上装工具链的场景。文档为 Docker 单独列了一节，说明它是被支持的部署方式，而不是需要自己拼凑的偏方。

资源占用

文档专门有一节讲资源使用情况（Resource usage），部署前值得先看这一节，用来判断你的机器或容器配额是否够用。具体数值以文档该节为准。

配置

配置分两层：必需选项（Required options）和详细选项（Detailed Options）。必需选项不填就跑不起来，详细选项按需调整。

传入配置有两种途径：

• 配置文件：文档给出了示例（Example）和格式说明（Format），照着格式写即可。
• 环境变量：同样给了示例（Example），适合容器化部署时注入配置。

两种方式覆盖的是同一组选项，选一种顺手的即可，不必混用。

跑起来之后

• 自动重定向：如果你部署实例的目的是让访问 Fandom 的人自动转到自己的 BreezeWiki，文档在「Automatic Redirection」一节给了多种做法，包括浏览器扩展 Indie Wiki Buddy、Redirector、Violentmonkey、LibRedirect，以及 Apple iPhone 上的重定向方式。
• 报告 bug：自己跑的过程中遇到问题，文档有「Reporting Bugs」一节，其中「Actually sending a report」说明了实际提交报告的渠道，另有其他沟通渠道。
• 继续开发：文档末尾的「Developing BreezeWiki」覆盖 Racket、文件结构、Fandom 端点、HTML 树变换、编程和测试，适合想在自建实例上做改动的人。

官方站点与镜像

文档的「Links」一节列出了官方站点、镜像（Mirrors）和 Onion 镜像三类地址。官方站点是 https://breezewiki.com。部署前可以先访问官方实例，确认它是否符合你的预期，再决定自建。

BreezeWiki 文档列出了几种把 Fandom 页面自动跳转到 BreezeWiki 的方式：浏览器扩展 Indie Wiki Buddy、Redirector、Violentmonkey、LibRedirect，以及 Apple iPhone 上的重定向方法。选择哪一种取决于你用的浏览器、是否愿意装扩展、以及是否希望只对特定站点生效。下面按方式说明各自的做法和适用条件。

先确认你要跳转到哪里

自动重定向的目标是 BreezeWiki 实例。文档在 Links 一节中区分了三类入口：

• Official：官方站点
• Mirrors：镜像站点
• Onion Mirrors：Tor 洋葱服务镜像

配置重定向规则时，需要把目标指向其中一个可用实例。如果你所在网络访问官方站点不稳定，可以改用镜像；对匿名性有要求时再考虑洋葱镜像（需要配合 Tor 浏览器）。

方式一：Indie Wiki Buddy（浏览器扩展）

文档把 Indie Wiki Buddy 列为自动重定向的第一种方式。它面向的是「独立 wiki 优先」的场景：当某个 Fandom wiki 存在对应的独立版本时，扩展会把你导向独立站点，BreezeWiki 属于这类目标之一。

适用条件：你希望安装一个扩展后自动处理，而不是自己写规则。适合不想维护规则列表的普通用户。

方式二：Redirector（浏览器扩展）

Redirector 通过自定义规则实现跳转，你需要自己指定「从哪个域名跳到哪里」。

适用条件：你想精确控制哪些 Fandom 域名被重定向、跳到哪个 BreezeWiki 实例。适合只需要处理少数几个 wiki 的情况。

配置时的关键点是：源地址匹配 Fandom 的域名模式，目标地址填你选定的 BreezeWiki 实例地址。

方式三：Violentmonkey（用户脚本管理器）

Violentmonkey 用来运行用户脚本。文档把它列为一种重定向途径，意味着你需要加载一段脚本，由脚本在页面加载时执行跳转。

适用条件：你已经在用 Violentmonkey 管理其他脚本，或者更习惯用脚本方式而不是扩展内置规则。

方式四：LibRedirect（浏览器扩展）

LibRedirect 的定位是把主流平台的链接重定向到注重隐私的替代前端。BreezeWiki 作为 Fandom 的替代前端，被纳入它的重定向目标之一。

适用条件：你已经在用 LibRedirect 处理其他服务（如 YouTube、Reddit 等）的重定向，希望把 Fandom 也一并交给它统一管理。

Apple iPhone 上的重定向

文档单独列出了 Apple iPhone redirect 一节。这说明在 iOS 上无法像桌面浏览器那样安装上述扩展，需要走另一套方法（例如借助支持脚本或规则的系统级工具）。如果你主要在 iPhone 上浏览，应优先看这一节，而不是照搬桌面扩展的做法。

几种方式的对比

遇到问题怎么反馈

文档设有 Reporting Bugs 一节，并区分了「Actually sending a report」和「Other communication channels」两部分。也就是说，提交问题时需要按文档说明的渠道发送，而不是随便找个入口留言。如果你在配置重定向时发现某个实例不可用或跳转异常，可以按这一节的指引反馈。

自己运行一个实例

如果现成实例都不满足需求，文档的 Running 一节覆盖了多种运行方式：

• 运行编译好的可执行文件
• 从源代码运行
• 更新源代码
• 用 Docker 运行
• 资源占用说明

其中还包含「What next?」的后续指引。运行自己的实例后，重定向规则里的目标地址就改成你自己的地址。

配置项在哪里查

自建实例需要配置。文档的 Configuration 一节分为：

• Required options：必填项
• Detailed Options：详细选项
• File：配置文件方式，含 Example 和 Format
• Environment variables：环境变量方式，含 Example

也就是说，配置既可以通过文件，也可以通过环境变量，两种方式文档都给了示例。必填项没配好，实例无法正常启动。

想改代码或参与开发

Developing BreezeWiki 一节面向开发者，内容包括：

• Racket（项目使用的语言）
• Files（文件结构）
• Fandom endpoints（Fandom 接口）
• HTML tree transformations（HTML 树变换）
• Programming
• Testing

如果你只是想用重定向，这部分可以跳过；如果你要修 bug 或改行为，从这里入手。

BreezeWiki 的官方入口是 https://breezewiki.com，普通镜像和 Onion 镜像的地址都列在 BreezeWiki Documentation 的 Links 部分。由于镜像站点可能随时增减或失效，实际使用时请以文档当前列出的地址为准，不要依赖第三方转述的旧列表。

文档中 Links 部分包含什么

BreezeWiki Documentation 的目录把 Links 放在最前面，其下分为三类：

• Official：官方站点
• Mirrors：普通镜像
• Onion Mirrors：通过 Tor 网络访问的镜像

这三类的区别在于访问方式和可用性：官方站点是主入口；普通镜像用于在官方站点不可用时替代访问；Onion 镜像需要通过 Tor 浏览器等支持 .onion 地址的工具打开。

如何找到当前可用的地址

1. 打开 BreezeWiki Documentation。
2. 定位到目录中的 Links 一节。
3. 在 Official 下获取官方地址，在 Mirrors 下获取普通镜像列表，在 Onion Mirrors 下获取 Onion 地址。
4. 逐个尝试，选择当前能正常打开的入口。

文档本身不保证某个镜像长期有效，所以每次需要时重新查看 Links 一节，比记住某个具体地址更可靠。

自动跳转到镜像的方式

如果你不想每次手动切换，文档的 Automatic Redirection 一节给出了几种把 Fandom 页面自动导向 BreezeWiki 的方案：

• Indie Wiki Buddy：浏览器扩展
• Apple iPhone redirect：iPhone 上的重定向配置
• Redirector：浏览器扩展
• Violentmonkey：用户脚本管理器
• LibRedirect：浏览器扩展

这些方案适用于你经常访问 Fandom 页面、希望自动改用 BreezeWiki 阅读的场景。具体配置步骤在文档对应小节中，按你的浏览器或设备选择其中一种即可。

遇到问题去哪里反馈

文档设有 Reporting Bugs 一节，包含“Actually sending a report”和“Other communication channels”两部分，分别对应正式提交报告的方式和其他沟通渠道。如果你发现某个镜像无法访问或页面显示异常，可以按这一节的说明反馈。

自己运行一份的入口

如果官方和镜像都不满足需求，文档的 Running 一节介绍了自行运行 BreezeWiki 的方式，包括：

• 运行编译好的可执行文件
• 从源代码运行
• 更新源代码
• 使用 Docker 运行
• 资源占用说明

继续深入还涉及 Configuration（必填选项、详细选项、配置文件与环境变量）和 Developing BreezeWiki（Racket、文件结构、Fandom 端点、HTML 树转换、编程与测试）。这条路径适合愿意自行部署、对配置和资源占用有明确预期的用户。