ITADN
xsf/xmpp.org
xsf/xmpp.org · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

xmpp.org

Build Website

请记录任何 issues

贡献新内容和更新

  • Fork 该 code 到你自己的 git 仓库。
  • /content 中或 directly via GitHub 进行你的更改。
  • 当你对你的更新满意时,提交一个 pull request 描述这些更改。
  • IMPORTANT: 在发送 Pull Request 之前,请确保你的 forked repo 与 base repo 保持同步。
  • 更新将被审查并合并。

交流论坛

请使用 xsf@muc.xmpp.org 讨论关于站点、内容、生成等事宜。

站点生成

  • 对 master 分支的 Commits 会生成一个新的 build。
  • Builds 可以在 Github Actions 查看。
  • 更改将在 xmpp.org 的下一次更新后显示。

Build instructions

Clone 此仓库:

git clone ssh://git@github.com/xsf/xmpp.org.git
cd xmpp.org

在本地或通过 Docker 构建:

常规构建

要在本地机器上运行开发服务器,请遵循以下基本步骤。 您需要安装以下依赖项:

  • Hugo
  • Python >=3.14 和 uv

开发服务器会在文件更改时自动重新构建页面:

make serve

http://localhost:1313 处的视图

Docker 构建

要在本地构建并运行网站,只需运行:

docker build -t xmpp-org --build-arg BASEURL=http://localhost/ --build-arg BUILDFUTURE=--buildFuture .

它将执行以下操作:

  • 构建一个包含完整依赖项的 Docker 镜像。
  • 从本地检出的 xmpp.org 仓库生成网站(make publish)。这包括来自 deploy/xsf.conf 的规则。

为了方便开发,您可以在本地提供该网站:

docker run -p 80:80 -t -i xmpp-org

http://localhost:80 处的视图

开发

仓库结构

<repo>
  content
    <website page files>
  public
    <generated files>
  src
    <content processing tools>
  themes
    <website theme>

Hugo 简介

Hugo 的快速入门页面是学习 Hugo 基础知识(设置、项目骨架、开发周期等)的好地方。

主题开发

xmpp.org 的主题使用了:

主题(布局和样式)可以在 /themes/xmpp.org 目录中进行自定义。

您可以直接修改 themes/xmpp.org/assets/css/style.css 中的样式。

内容处理

为了处理底层数据以呈现例如 /extensions/software,使用了一组位于 /src 的脚本。