From 621ac92ae1be2a9982ec5be446f9069dc4aba023 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Wed, 28 Oct 2020 15:25:52 +0200 Subject: [PATCH] Migrate wiki docs to rtd format --- docs/index.rst | 2 + docs/themes-list/index.rst | 558 +++++++++++++++++++++++++++++++++++++ docs/themes.rst | 35 +++ docs/troubleshooting.rst | 16 ++ 4 files changed, 611 insertions(+) create mode 100644 docs/themes-list/index.rst create mode 100644 docs/troubleshooting.rst diff --git a/docs/index.rst b/docs/index.rst index 7f4649e7..e5bc2667 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,8 +21,10 @@ Stop polluting your ``~/bin`` directory and your ``.bashrc`` file, fork/clone Ba commands/index custom themes + themes-list/index vcs_user misc + troubleshooting uninstalling diff --git a/docs/themes-list/index.rst b/docs/themes-list/index.rst new file mode 100644 index 00000000..0df4c087 --- /dev/null +++ b/docs/themes-list/index.rst @@ -0,0 +1,558 @@ +.. _list_of_themes: + +List of Themes +============== + +Below is a list of all of the themes (with screenshots) that `bash-it `_ ships with. + +Alphabetical List: +------------------ + +Bakke +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bakke-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bakke-black.jpg + :alt: Bakke + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bakke-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bakke-white.jpg + :alt: Bakke + + +---- + +BarbUk +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/BarbUk-black.png + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/BarbUk-black.png + :alt: BarbUk + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/BarbUk-white.png + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/BarbUk-white.png + :alt: BarbUk + + +---- + +Bobby +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bobby-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bobby-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bobby-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/bobby-white.jpg + :alt: + + +---- + +Brunton +^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/brunton-black.png + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/brunton-black.png + :alt: + + +---- + +Candy +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/candy-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/candy-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/candy-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/candy-white.jpg + :alt: + + +---- + +Clean +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/clean-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/clean-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/clean-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/clean-white.jpg + :alt: + + +---- + +Demula +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/demula-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/demula-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/demula-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/demula-white.jpg + :alt: + + +---- + +DOS +^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/dos-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/dos-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/dos-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/dos-white.jpg + :alt: + + +---- + +DoubleTime +^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime-white.jpg + :alt: + + +---- + +DoubleTime Multiline +^^^^^^^^^^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline-white.jpg + :alt: + + +---- + +Doubletime Multiline Python Only +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline_pyonly-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline_pyonly-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline_pyonly-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/doubletime_multiline_pyonly-white.jpg + :alt: + + +---- + +Envy +^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/envy-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/envy-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/envy-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/envy-white.jpg + :alt: + + +---- + +Iterate +^^^^^^^ + +Responsively wraps prompt based on terminal width. + + +.. image:: https://cloud.githubusercontent.com/assets/1319655/2923152/3a763194-d70e-11e3-9e52-3740de9bbb9b.png + :target: https://cloud.githubusercontent.com/assets/1319655/2923152/3a763194-d70e-11e3-9e52-3740de9bbb9b.png + :alt: + + +.. image:: https://cloud.githubusercontent.com/assets/1319655/2923143/14b8e0d2-d70e-11e3-9706-f5341fff8e5c.png + :target: https://cloud.githubusercontent.com/assets/1319655/2923143/14b8e0d2-d70e-11e3-9706-f5341fff8e5c.png + :alt: + + +---- + +Mr Briggs +^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/mbriggs-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/mbriggs-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/mbriggs-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/mbriggs-white.jpg + :alt: + + +---- + +Minimal +^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/minimal-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/minimal-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/minimal-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/minimal-white.jpg + :alt: + + +---- + +Modern +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-white.jpg + :alt: + + +---- + +Modern T +^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-t-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-t-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-t-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/modern-t-white.jpg + :alt: + + +---- + +Metal +^^^^^ + + +.. image:: https://raw.githubusercontent.com/jrab66/bash-it/7cc82b518d6286fc68c8477d809ce9f417501976/themes/metal/metalthemeblack.png + :target: https://raw.githubusercontent.com/jrab66/bash-it/7cc82b518d6286fc68c8477d809ce9f417501976/themes/metal/metalthemeblack.png + :alt: + + +---- + +n0Qorg +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/n0qorg-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/n0qorg-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/n0qorg-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/n0qorg-white.jpg + :alt: + + +---- + +NWinkler +^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/nwinkler-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/nwinkler-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/nwinkler-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/nwinkler-white.jpg + :alt: + + +---- + +Pete +^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pete-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pete-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pete-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pete-white.jpg + :alt: + + +---- + +Powerline +^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-white.jpg + :alt: + + +---- + +Powerline Naked +^^^^^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-naked-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-naked-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-naked-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-naked-white.jpg + :alt: + + +---- + +Powerline Plain +^^^^^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-plain-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-plain-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-plain-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/powerline-plain-white.jpg + :alt: + + +---- + +Pure +^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pure-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pure-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pure-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/pure-white.jpg + :alt: + + +---- + +RainbowBrite +^^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rainbowbrite-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rainbowbrite-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rainbowbrite-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rainbowbrite-white.jpg + :alt: + + +---- + +R Jorgenson +^^^^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rjorgenson-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rjorgenson-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rjorgenson-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/rjorgenson-white.jpg + :alt: + + +---- + +Sexy +^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sexy-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sexy-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sexy-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sexy-white.jpg + :alt: + + +---- + +Simple +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/simple-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/simple-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/simple-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/simple-white.jpg + :alt: + + +---- + +SirUp +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sirup-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sirup-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sirup-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/sirup-white.jpg + :alt: + + +---- + +Standard +^^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/standard-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/standard-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/standard-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/standard-white.jpg + :alt: + + +---- + +Tonka +^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tonka-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tonka-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tonka-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tonka-white.jpg + :alt: + + +---- + +Tylenol +^^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tylenol-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tylenol-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tylenol-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/tylenol-white.jpg + :alt: + + +---- + +Zitron +^^^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zitron-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zitron-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zitron-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zitron-white.jpg + :alt: + + +---- + +Zork +^^^^ + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zork-black.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zork-black.jpg + :alt: + + +.. image:: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zork-white.jpg + :target: https://raw.github.com/wiki/revans/bash-it/images/screenshots/zork-white.jpg + :alt: diff --git a/docs/themes.rst b/docs/themes.rst index 27b93a29..aa21a7e3 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -29,6 +29,41 @@ You can see theme screenshots on `wiki/Themes `. + +Theme Switches & Variables +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Clock Related +============= + +function: ``clock_char`` +######################## + +Prints a character indicating clock. + + +* ``THEME_SHOW_CLOCK_CHAR`` : **true**\ /false + +* ``THEME_CLOCK_CHAR`` : "\ **⌚**\ " + +* ``THEME_CLOCK_CHAR_COLOR`` : "\ **$normal**\ " + +function: ``clock_prompt`` +########################## + +Prints the clock prompt (date, time). + + +* ``THEME_SHOW_CLOCK`` : **true**\ /false + +* ``THEME_CLOCK_COLOR`` : "\ **$normal**\ " + +* ``THEME_CLOCK_FORMAT`` : "\ **%H:%M:%S**\ " + Contributing a new theme ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst new file mode 100644 index 00000000..6503699a --- /dev/null +++ b/docs/troubleshooting.rst @@ -0,0 +1,16 @@ +.. _troubleshooting: + +Troubleshooting Guide +===================== + +Table of Contents +----------------- + +* `I'm stuck in the LightDM login screen after setting up bash-it. `_ + +I'm stuck in the LightDM login screen after setting up bash-it +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Possible issue**\ : `#672 `_ + +**Solution**\ : Check `this comment `_ for detailed information about the cause and solution for this issue.