From bbc14304208bc36640a049ecef9cb6d03cb5acd0 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Wed, 30 May 2018 12:08:20 +0530 Subject: [PATCH] Add a support page Also fix a few links flagged by make linkcheck --- docs/_static/custom.css | 44 ++++++++++++++++++++++++++++++++++-- docs/_templates/support.html | 7 ++++++ docs/conf.py | 2 ++ docs/faq.rst | 2 +- docs/protocol-extensions.rst | 6 +++-- docs/support.rst | 19 ++++++++++++++++ 6 files changed, 75 insertions(+), 5 deletions(-) create mode 100644 docs/_templates/support.html create mode 100644 docs/support.rst diff --git a/docs/_static/custom.css b/docs/_static/custom.css index f7e79d2dc..4bf1395fc 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -11,16 +11,56 @@ margin-bottom: 1em; } +.float-right-img { float: right; margin-left: 1em; margin-bottom: 1em } + +.half-with-img { max-width: 50% } + +.fit-img { max-width: 95% } + +div.body p, div.body dd, div.body li, div.body blockquote { + text-align: justify; +} + +pre { + white-space: pre-wrap; +} + +a[href], input[type="submit"] { cursor: pointer; } + a { text-decoration: none !important; border-bottom: none !important; } -#searchbox h3 { - display: none; +body div.document { + margin-top: 1ex; } .major-features li { margin-top: 0.75ex; margin-bottom: 0.75ex; } + +.support-form input[type=submit] { + border-radius: 6px; + box-shadow: rgb(255, 246, 175) 0px 1px 0px 0px; + background: linear-gradient(rgb(255, 236, 100) 5%, rgb(255, 171, 35) 100%) rgb(255, 236, 100); + border: 1px solid rgb(255, 170, 34); + display: inline-block; + color: rgb(51, 51, 51); + font-family: Arial; + font-size: 15px; + font-weight: bold; + padding: 6px 24px; + text-decoration: none; + text-shadow: rgb(255, 238, 102) 0px 1px 0px; +} + +.support-form input[type=submit]:hover { + background: linear-gradient(rgb(255, 171, 35) 5%, rgb(255, 236, 100) 100%) rgb(255, 171, 35); +} + +.support-form input[type=submit]:focus { + outline: 0; +} + diff --git a/docs/_templates/support.html b/docs/_templates/support.html new file mode 100644 index 000000000..43338c62c --- /dev/null +++ b/docs/_templates/support.html @@ -0,0 +1,7 @@ +{% if pagename != "support" %} +
+
+ +
+
+{% endif %} diff --git a/docs/conf.py b/docs/conf.py index a841d509d..2e9621a5e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,6 +118,7 @@ html_static_path = ['_static', '../logo/kitty.png'] html_context = { 'css_files': ['_static/custom.css'] } +html_favicon = '../logo/kitty.png' # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -130,6 +131,7 @@ html_context = { html_sidebars = { '**': [ 'about.html', + 'support.html', 'searchbox.html', 'localtoc.html', 'relations.html', diff --git a/docs/faq.rst b/docs/faq.rst index b3f565991..67f2e225c 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -53,8 +53,8 @@ it by adding the following to your vimrc:: let &t_ut='' +See :ref:`here ` for why |kitty| does not support background color erase. -See `here `_ for why |kitty| does not support background color erase. I get errors about the terminal being unknown or opening the terminal failing when SSHing into a different computer? ----------------------------------------------------------------------------------------------------------------------- diff --git a/docs/protocol-extensions.rst b/docs/protocol-extensions.rst index ce4792ab6..33fb2e563 100644 --- a/docs/protocol-extensions.rst +++ b/docs/protocol-extensions.rst @@ -27,7 +27,7 @@ Colored and styled underlines use in terminal editors such as vim and emacs to display red, wavy underlines under mis-spelled words and/or syntax errors. This is done by re-purposing some SGR escape codes that are not used in modern terminals (`CSI codes -`_) +`_) To set the underline style:: @@ -98,7 +98,7 @@ and to leave *full mode*, use DECRST:: The number ``2017`` above is not used for any existing modes, as far as I know. Client programs can query if the terminal emulator is in *full mode* by using -the standard `DECRQM `_ escape sequence. +the standard `DECRQM `_ escape sequence. The new mode works as follows: @@ -142,6 +142,8 @@ This encoding means each key event is represented by 8 or 9 printable ascii only bytes, for maximum robustness. +.. _ext_styles: + Setting text styles/colors in arbitrary regions of the screen ------------------------------------------------------------------ diff --git a/docs/support.rst b/docs/support.rst new file mode 100644 index 000000000..69e4f279e --- /dev/null +++ b/docs/support.rst @@ -0,0 +1,19 @@ +Support kitty development +=========================== + +My goal with |kitty| is to move the stagnant terminal ecosystem forward. To that +end kitty has many foundational features, such as: :doc:`image support +`, :doc:`superlative performance `, +:doc:`various enhancements to the terminal protocol `, +etc. These features allow the development of rich terminal applications, such +as :doc:`Side-by-side diff `, :doc:`Unicode input +`, etc. + +If you wish to support this mission and see the terminal ecosystem evolve, +consider donating so that I can devote more time to |kitty| development. +I have personally written `almost all kitty code +`_. + +You can use the `Patreon `_ or `Liberapay +`_ services to support my kitty +development.