mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-17 14:04:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve generation of default config files

Browse Source 
- config files are placed into `docs/generated/conf/`, using the
  expected name, and without any indentation
- `literalinclude::` is used instead of `include::`
- uses `:download:` instead of `:file:` to allow for downloading the
  generated files easily
This commit is contained in:
Daniel Hahler
2018-06-16 18:35:58 +02:00
parent 49b065cbe7
commit 8a0cd73821
3 changed files with 12 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/conf.rst
View File

@@ -35,6 +35,7 @@ expanded, so :code:`${USER}.conf` becomes :file:`name.conf` if
Sample kitty.conf
^^^^^^^^^^^^^^^^^^^^^
Below is a sample :file:`kitty.conf` with all default settings.
Below is a sample :download:`kitty.conf </generated/conf/kitty.conf>` with all default settings.
.. include:: /generated/conf-kitty-literal.rst
.. literalinclude:: /generated/conf/kitty.conf
:language: conf