README.md

i3wm.org: The website for the i3 tiling window manager

This is the source code for the official i3 website: https://i3wm.org/.

Building

You will need Hugo and AsciiDoc.

To rebuild the website after making changes, run hugo (without parameters) and hugo will generate the website into the docs directory.

To preview your changes, run hugo serve.

If you want to push changes to the documentation, update the relevant file(s) in content/_docs, then:

1. Generate the docs from the content/_docs folder with make -C content/_docs -j.

2. Move the HTML files from _docs to docs (notice the underscore!): mv content/_docs/*.html content/docs/.

Contributing

Changes to the docs should happen first on the i3 source code repository, in the docs folder. So, for example, if you want to make changes to the userguide you will have to submit a pull request first to the i3 github repository and then (optionally, if your change should be applied immediately to the userguide) submit a PR in this repository as well.

Docs use the AsciiDoc format. Edit the file in _docs, then follow the building process above. When submitting a pull request, include both the changed files in _docs and the corresponding generated HTML files.