Start work on a kitty website

Port the current asciidoc documentation to sphinx
This commit is contained in:
Kovid Goyal
2018-05-29 21:03:50 +05:30
parent edda0d91bb
commit f82b7841c6
23 changed files with 1786 additions and 569 deletions

23
docs/conf.rst Normal file
View File

@@ -0,0 +1,23 @@
Configuring kitty
===============================
|kitty| is highly customizable, everything from keyboard shortcuts, to painting
frames-per-second. See the heavily commented default config file below for an
overview of all customization possibilities.
You can open the config file within kitty by pressing |sc_edit_config_file|.
You can also display the current configuration by running ``kitty
--debug-config``.
.. literalinclude:: ../kitty/kitty.conf
:language: ini
|kitty| looks for a config file in the OS config directories (usually
:file:`~/.config/kitty/kitty.conf` and additionally
:file:`~/Library/Preferences/kitty/kitty.conf` on macOS) but you can pass a
specific path via the ``--config`` option or use the ``KITTY_CONFIG_DIRECTORY``
environment variable. See the help for the :option:`--config` option in ``kitty
--help`` for full details.