Repository files navigation

Please log anyissues.

• Fork thecode to your own git repository.
• Make your changes in/content ordirectly via GitHub.
• When you are happy with your updates, submit apull request describing the changes.
• IMPORTANT: Before sending aPull Request make sure that your forked repo is in sync with the base repo.
• The updates will be reviewed and merged in.

Please usexsf@muc.xmpp.org for discussions about the site, content, generation etc.

• Commits to the master branch generate a new build.
• Builds are visible atGithub Actions.
• Changes will be visible onxmpp.org after the next update.

Clone this repository:

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

Build locally or via Docker:

• Local (regular) build
• Docker container build

To run a development server on your local machine, follow these basic steps.You need to have the following dependencies installed:

• Hugo
• Python >=3.14 and uv

The development server will automatically rebuild the page whenever a file is changed:

make serve

View athttp://localhost:1313

To build and serve the website locally, simply run:

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

It will do the following:

• Build a Docker image with a complete set of dependencies ready.
• Generate the website from the locally checked out xmpp.org repository (make publish). This includes rules fromdeploy/xsf.conf.

For development convenience, you can serve the website locally:

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

View athttp://localhost:80

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

Hugo’squickstart page is a good place to learn about the basics of Hugo (setup, project skeleton, development cycle, etc.).

xmpp.org's theme makes use of:

• Bootstrap 5.3
• FontAwesome 7

The theme (layout and styling) can be customized in the/themes/xmpp.org directory.

You can directly modify styles inthemes/xmpp.org/assets/css/style.css.

To process underlying data to present e.g./extensions or/software, a set of scripts located in/src is used.