返回目录
开源项目文档办公类新手

Home Assistant 用户文档站点源码(home-assistant.io)

该仓库是 Home Assistant 官方用户文档网站 home-assistant.io 的源码,社区通过提交 Pull Request 贡献文档,站点按 current/rc/next 分支分别对应生产、Beta 与开发环境,每个 PR 由 Netlify 提供预览部署。

0 次阅读2026/09/17 发布
Home Assistant 用户文档站点源码(home-assistant.io) 来源图片

社区作者 · zZz

它解决什么问题

这是 Home-Assistant.io 网站的源码仓库,用于承载 Home Assistant 的用户文档内容。

访问入口按目标分支区分:

  • 生产环境(current 分支):https://www.home-assistant.io
  • Beta 环境(rc 分支):https://rc.home-assistant.io
  • 开发环境(next 分支):https://next.home-assistant.io

此外,Netlify 会为每个 Pull Request 提供预览部署,链接出现在该 PR 的第一条评论中。

贡献流程:如何为文档做贡献以及提交 Pull Request 的流程,在开发者文档(developer documentation)中说明,来源未展开具体步骤,待核验。

本地与生成相关能力来自仓库给出的 rake 任务:可用 bundler 命令启动本地站点预览,可在预览不在本机时传入目标机器 IP,也可通过 isolate/integrate 临时移出与恢复博客文章以加速站点生成。

适用对象:希望提交或修订 Home Assistant 文档的社区贡献者、文档维护者与翻译/本地化人员,以及需要本地构建文档站点做校对的人员。

许可证:来源正文未提及许可证信息,待核验。

— 本文由 AI 根据公开来源辅助整理,命令、版本与许可证请在使用前到原始页面复核。

安装 / 开始使用

  1. 准备环境:来源说明“为文档做贡献的环境搭建与提交 Pull Request 的流程见开发者文档(developer documentation)”,未在正文列出具体依赖、版本与安装命令,待核验;从正文出现的 bundler、rake 命令看,本地需要可执行 bundle/rake 的运行环境。

bundle exec rake preview

bundle exec rake preview[192.168.0.123]

bundle exec rake isolate[filename-of-blogpost]

bundle exec rake integrate

  1. 本地启动站点预览(在 http://127.0.0.1:4000 提供预览):
  2. 若预览不在本机运行,把目标机器的 IP 作为参数传入,例如要在 http://192.168.0.123:4000 上访问:
  3. 加速站点生成:每次发布都会在网站发布很长的 changelog,会显著拖慢站点生成;仓库提供了工具,可临时排除当前不处理的博客文章:
  4. 站点工作完成后,用以下命令把文章移回原位:
  5. 首次运行与常见问题:来源未提供依赖安装、首次运行报错与排错说明,待核验。
  1. 在线预览:每个 Pull Request 都会由 Netlify 提供预览部署,链接在该 PR 的第一条评论中。

适用场景

向 Home Assistant 官方用户文档提交或修订内容的社区贡献者
在本地构建并预览文档站点以校对改动的文档维护者
参与文档翻译与本地化的贡献者
需要查看 PR 预览部署来评审文档改动的审核人员
按 current/rc/next 分支区分生产
Beta
开发文档版本的团队