Skip to content
Draft
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ Powerline style.

install
theme/powerline
theme/powerline_full
theme/powerline_plus
theme/power2lines
theme/powerpuff
2 changes: 2 additions & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
CMake
GitHub
Kubernetes
Powerline
Expand All @@ -6,6 +7,7 @@ chroot
config
hostname
js
Powerpuff
runtime
username
workspace
Binary file added docs/theme/images/power2lines-long.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/images/power2lines-med.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/images/power2lines-short.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline-long.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline-med.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline-short.png
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only issue with these screenshots is that the cursor character looks different between them. Probably because it is blinking? A small nitpick to be sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. This comes from the automated screenshot scripts, so that the cursor is always displayed. Should I patch them in Gimp or is it OK as is?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My need for perfection wants it patched out, but you can do whatever.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline_full-long.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline_full-med.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/theme/images/powerline_full-short.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/images/powerpuff-long.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/images/powerpuff-med.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/theme/images/powerpuff-short.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/theme/power2lines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Power2lines
***********

This ``power2line`` theme rearranges the sections of :doc:`powerline_plus`, but on two rows instead of one.
That is, the data sections are displayed on a first row, and the interactive prompt forms a second row.
This gives room for long command lines, and let the user find the prompt always at the same location.


Preview
=======

If there is nothing special about the current context, the appearance of
Powerline might be as simple as this:

.. image:: images/power2lines-short.png

A slightly longer prompt with more data:

.. image:: images/power2lines-med.png

When Liquid Prompt is displaying nearly everything, it may look like this:

.. image:: images/power2lines-long.png


Setup & Configuration
=====================

This theme as the same core configuration than the :doc:`powerline_plus` theme.

Theme Configuration
-------------------

Colors
______

.. attribute:: POWERLINE_LINE_COLOR
:type: array<int>
:value: (240 -1 0 0 14 -1)

Color of the decorative lines.

5 changes: 1 addition & 4 deletions docs/theme/powerline.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Powerline
*********

.. contents::
:local:

The ``powerline`` theme is a clone of the `Powerline prompt`_. It copies the
`default segments`_ of the Powerline prompt for Shell.

Expand Down Expand Up @@ -41,7 +38,7 @@ When Liquid Prompt is displaying nearly everything, it may look like this:
The above "everything" image looks like it is missing some parts because this
theme does not implement all data sources of Liquid Prompt. This is by design
to clone basic Powerline. For a Powerline theme that does show all data
sources, see :doc:`powerline_full`.
sources, see :doc:`powerline_plus`.

Configuration
=============
Expand Down
49 changes: 45 additions & 4 deletions docs/theme/powerline_full.rst → docs/theme/powerline_plus.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Powerline Full
Powerline Plus
**************

.. contents::
:local:

An extension of the :doc:`powerline` theme, ``powerline_full`` includes all data
An extension of the :doc:`powerline` theme, ``powerline_plus`` includes all data
sources that Liquid Prompt provides. The ordering is the same as the default
theme.

Expand Down Expand Up @@ -41,8 +41,13 @@ All Liquid Prompt config options are respected, **except for**:

* :attr:`LP_COLOR_AWS_PROFILE`
* :attr:`LP_COLOR_CONTAINER`
* :attr:`LP_COLOR_CMAKE_DEBUG`
* :attr:`LP_COLOR_CMAKE_RELEASE`
* :attr:`LP_COLOR_CMAKE_RWDI`
* :attr:`LP_COLOR_DIRSTACK`
* :attr:`LP_COLOR_ERR`
* :attr:`LP_COLOR_ENV_VARS_UNSET`
* :attr:`LP_COLOR_ENV_VARS_SET`
* :attr:`LP_COLOR_HOST`
* :attr:`LP_COLOR_IN_MULTIPLEXER`
* :attr:`LP_COLOR_JOB_D`
Expand All @@ -52,6 +57,7 @@ All Liquid Prompt config options are respected, **except for**:
* :attr:`LP_COLOR_MARK_ROOT`
* :attr:`LP_COLOR_MARK_SUDO`
* :attr:`LP_COLOR_MARK`
* :attr:`LP_COLOR_MODULES`
* :attr:`LP_COLOR_NODE_VENV`
* :attr:`LP_COLOR_NOWRITE`
* :attr:`LP_COLOR_PATH_ROOT`
Expand All @@ -78,11 +84,16 @@ All Liquid Prompt config options are respected, **except for**:
* :attr:`LP_MARK_BRACKET_CLOSE`
* :attr:`LP_MARK_BRACKET_OPEN`
* :attr:`LP_MARK_BZR`
* :attr:`LP_MARK_CMAKE`
* :attr:`LP_MARK_DEFAULT`
* :attr:`LP_MARK_DISABLED`
* :attr:`LP_MARK_FOSSIL`
* :attr:`LP_MARK_GIT`
* :attr:`LP_MARK_HG`
* :attr:`LP_MARK_MODULES_OPEN`
* :attr:`LP_MARK_MODULES_SEP`
* :attr:`LP_MARK_MODULES_CLOSE`
* :attr:`LP_MARK_OS_SEP`
* :attr:`LP_MARK_PERM`
* :attr:`LP_MARK_PREFIX`
* :attr:`LP_MARK_PROXY`
Expand All @@ -92,15 +103,15 @@ All Liquid Prompt config options are respected, **except for**:
Theme Configuration
-------------------

Powerline Full uses all the config options of the :doc:`powerline` theme,
Powerline Plus uses all the config options of the :doc:`powerline` theme,
**except for**:

* :attr:`POWERLINE_STASH_MARKER`
* :attr:`POWERLINE_VCS_DIRTY_COLOR`
* :attr:`POWERLINE_VCS_MARKER`
* :attr:`POWERLINE_VCS_STASH_COLOR`

Powerline Full adds these config options:
Powerline Plus adds these config options:

Markers
_______
Expand Down Expand Up @@ -184,6 +195,12 @@ ______

Color for the chroot section.

.. attribute:: POWERLINE_CMAKE_COLOR
:type: array<int>
:value: (0, 123, 0, 0, 0, 10)

Color for the CMake section.

.. attribute:: POWERLINE_CONTAINER_COLOR
:type: array<int>
:value: $POWERLINE_NEUTRAL_COLOR
Expand All @@ -196,6 +213,18 @@ ______

Color for the directory stack section.

.. attribute:: POWERLINE_ENV_VARS_COLOR_SET
:type: array<int>
:value: (0 250 0 0 0 13)

Color for segment of user-defined environment variables that are set.

.. attribute:: POWERLINE_ENV_VARS_COLOR_UNSET
:type: array<int>
:value: (7 246 0 0 7 5)

Color for segment of user-defined environment variables that are unset.

.. attribute:: POWERLINE_KUBECONTEXT_COLOR
:type: array<int>
:value: (231, 74, 0, 0, 7, 4)
Expand All @@ -208,6 +237,12 @@ ______

Color for the CPU load section.

.. attribute:: POWERLINE_MODULES_COLOR
:type: array<int>
:value: (0 158 0 0 0 10)

Color for the Environment Modules section.

.. attribute:: POWERLINE_NEUTRAL_COLOR
:type: array<int>
:value: (252, 234, 0, 0, 7, 0)
Expand All @@ -221,6 +256,12 @@ ______

Color for the Node.js environment section.

.. attribute:: POWERLINE_OS_COLOR
:type: array<int>
:value: (0 194 0 0 0 10)

Color for the Operating System section.

.. attribute:: POWERLINE_PROXY_COLOR
:type: array<int>
:value: (21, 219, 1, 0, 4, 7)
Expand Down
38 changes: 38 additions & 0 deletions docs/theme/powerpuff.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Powerpuff
*********

This ``powerpuff`` theme go even further in rearranging the sections of the :doc:`powerline_plus` theme:

- Data sections are spread on two rows,
- each of which has a left-aligned and a right-aligned section.
- A third row hosts the actual interactive prompt.
- A horizontal line link the left and right sections of the first line.
- A new line is drawn before the first row.

The meta-sections are thus less prone to move around when more data is displayed,
and the user will find it easier to spot new information.
The horizontal line and the new line gap also helps in parsing screens with a lot of history.


Preview
=======

If there is nothing special about the current context, the appearance of
Powerline might be as simple as this:

.. image:: images/powerpuff-short.png

A slightly longer prompt with more data:

.. image:: images/powerpuff-med.png

When Liquid Prompt is displaying nearly everything, it may look like this:

.. image:: images/powerpuff-long.png


Setup & Configuration
=====================

This theme as the same core configuration than the :doc:`power2lines` theme.

Loading