BreezeWiki Documentation 是什么网站?
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 树变换、编程与测试。
普通用户会用到哪几节
如果你只是访问者,重点在两节:
- Links 提供可用的官方地址、镜像地址和 Onion 地址。镜像的存在意味着某个域名不可用时可以换一个。
- 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 环境和测试方式。