Repository files navigation

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

You will needJekyll andAsciiDoc.First, generate the docs from the_docs folder withmake -C _docs -j.Move the HTML files from_docs todocs (notice the underscore!):mv _docs/*.html docs/.Then, usejekyll build and you can finally serve the website locally withjekyll serve.

Changes to the docs should happen first on the i3 source code repository,in thedocs folder.So, for example, if you want to make changes to theuserguideyou 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 theAsciiDoc format.Edit the file in_docs, then follow the building process above.When submitting a pull request, include both the changed files in_docs andthe corresponding generated HTML files.