DOCSEARCHbyAlgolia
Submit Docs

i3 Tiling Window Manager Documentation

repository·main·Indexed 42 days ago

https://github.com/i3/i3.github.io

Official documentation for the i3 tiling window manager, built using Hugo and AsciiDoc.

Tokens
381
Snippets
2
Records
3
Agent score
4%

What's inside i3

  2. Contribute changes to the i3 documentation

    main

    Documentation changes must follow a specific workflow because the primary source of truth is the i3 window manager source code repository:

    1. Submit to i3 source code: Make your changes in the docs folder of the i3 source repository and submit a pull request there first.
    2. Submit to i3 website (optional): If you want the changes applied to the website immediately, submit a second pull request to this repository.

    Important for Pull Requests:

    • Documentation is written in AsciiDoc format.
    • When submitting a PR to this repository, you must include both the original source files from _docs and the corresponding generated .html files.

  3. Update documentation files

    main

    To update the documentation, modify the relevant files in the content/_docs directory. Follow these steps to generate and move the new HTML files:

    1. Generate the documentation from the content/_docs folder using make -C content/_docs -j.
    2. Move the generated HTML files from the temporary _docs folder to the final docs folder using: mv content/_docs/*.html content/docs/.
    make -C content/_docs -j
mv content/_docs/*.html content/docs/