Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Johann Dreo
liquidprompt
Commits
4214b446
Commit
4214b446
authored
Jul 17, 2021
by
Otto Kekäläinen
Browse files
Unify project name as "Liquid Prompt" in docs (spelled as two words)
parent
4ce49d1f
Changes
25
Hide whitespace changes
Inline
Side-by-side
.github/ISSUE_TEMPLATE/bug.md
View file @
4214b446
---
name
:
Bug report
about
:
Create a report to help us improve Liquid
p
rompt
about
:
Create a report to help us improve Liquid
P
rompt
title
:
'
'
labels
:
'
bug'
assignees
:
'
'
...
...
@@ -27,13 +27,13 @@ Shell:
-->
Operating system:
<!---
Liquid
p
rompt version, tag, or commit.
Liquid
P
rompt version, tag, or commit.
Find with
`git describe --tags --exact-match`
or
`git rev-parse HEAD`
in the liquidprompt repo.
Please only report bugs that you have tested against the master branch
Example: "v1.12"
-->
Liquid
p
rompt version:
Liquid
P
rompt version:
### Steps to Reproduce
<!--- Provide an unambiguous set of steps to reproduce this bug.
...
...
@@ -50,4 +50,3 @@ Liquidprompt version:
### Possible Solution
<!--- Optional, suggest an idea for fixing the bug -->
.github/ISSUE_TEMPLATE/enhancement.md
View file @
4214b446
---
name
:
Feature request
about
:
Suggest an idea for Liquid
p
rompt
about
:
Suggest an idea for Liquid
P
rompt
title
:
'
'
labels
:
'
enhancement'
assignees
:
'
'
...
...
@@ -17,4 +17,3 @@ assignees: ''
### Example prompt
<!--- Show us what a prompt with this feature enabled would look like -->
CHANGELOG.md
View file @
4214b446
...
...
@@ -206,7 +206,7 @@ for help.
-
**temperature**
:
`_lp_temperature()`
as data function ([69c75a3])
-
**terminal**
:
`_lp_terminal_device()`
data function ([5076dbe])
-
**tests**
: Shunit2 testing suite ([#469], [46918f6], [44e3a6f], [1fe1559])
-
**tests**
: Tests to check if a shell supports all features that Liquid
p
rompt
-
**tests**
: Tests to check if a shell supports all features that Liquid
P
rompt
needs ([46918f6], [5a9293d], [1fe1559])
-
**tests**
: Tests for
`_lp_as_text()`
([6cdb860])
-
**tests**
: Tests for
`_lp_battery()`
/
`acpi`
([cef9cb1])
...
...
@@ -268,7 +268,7 @@ for help.
### Fixed
-
**general**
: Issues with custom
`$IFS`
([e48856b], [4ebc26e])
-
**general**
: Liquid
p
rompt is now
`set -u`
compatible ([#354], [a8aa8c9], [cb9d71b])
-
**general**
: Liquid
P
rompt is now
`set -u`
compatible ([#354], [a8aa8c9], [cb9d71b])
-
**acpi**
: Temperature check printed each temp twice, slowing down check ([cf8bf97])
-
**acpi**
: Temperature check used extended sed syntax without declaring extended language ([eb30942])
-
**battery**
: Color display would break with custom
`$LP_COLORMAP`
array ([f3f20ec])
...
...
CONTRIBUTING.md
View file @
4214b446
...
...
@@ -68,7 +68,7 @@ for our standards on shell language.
$ git clone -o upstream git://github.com/nojhan/liquidprompt.git
$ cd liquidprompt
# Run
l
iquid
p
rompt and check that your issue is still on that branch
# Run
L
iquid
P
rompt and check that your issue is still on that branch
$ source liquidprompt
# Prepare a fix (include the issue number in the branch name if an issue
...
...
README.md
View file @
4214b446
...
...
@@ -14,8 +14,8 @@ You can even use it with your favorite shell – Bash or zsh.
## Documentation
See the
[
Liquid
p
rompt documentation
](
https://liquidprompt.readthedocs.io/
)
for
details on installing and configuring Liquid
p
rompt.
See the
[
Liquid
P
rompt documentation
](
https://liquidprompt.readthedocs.io/
)
for
details on installing and configuring Liquid
P
rompt.
## License
...
...
contrib/README.md
View file @
4214b446
# liquidprompt/contrib Policy
This directory contains files that have been contributed by contributors
but that the core Liquid
p
rompt maintainers do not maintain.
but that the core Liquid
P
rompt maintainers do not maintain.
So they are probably outdated and possibly poor quality (because the maintainers
may not have the knowledge to properly review them).
...
...
docs/conf.py
View file @
4214b446
...
...
@@ -18,8 +18,8 @@ import time
# -- Project information -----------------------------------------------------
project
=
'Liquid
p
rompt'
copyright
=
'2011-%s, Liquid
p
rompt team'
%
time
.
strftime
(
'%Y'
)
project
=
'Liquid
P
rompt'
copyright
=
'2011-%s, Liquid
P
rompt team'
%
time
.
strftime
(
'%Y'
)
author
=
'Mark Vander Stel'
...
...
@@ -34,9 +34,9 @@ extensions = [
# This value determines how to group the document tree into manual pages
man_pages
=
[
(
'functions'
,
'liquidprompt'
,
'Liquid
p
rompt functions'
,
[],
3
),
(
'config'
,
'liquidprompt'
,
'Liquid
p
rompt configuration'
,
[],
5
),
(
'theme'
,
'liquidprompt'
,
'Liquid
p
rompt theming'
,
[],
7
),
(
'functions'
,
'liquidprompt'
,
'Liquid
P
rompt functions'
,
[],
3
),
(
'config'
,
'liquidprompt'
,
'Liquid
P
rompt configuration'
,
[],
5
),
(
'theme'
,
'liquidprompt'
,
'Liquid
P
rompt theming'
,
[],
7
),
]
# A URL to cross-reference manpage directives
...
...
docs/config.rst
View file @
4214b446
...
...
@@ -4,9 +4,9 @@ Config Options
.. contents::
:local:
Almost every feature in Liquid
p
rompt can be turned on or off using these config
options. They can either be set before sourcing Liquid
p
rompt (in ``.bashrc`` or
``.zshrc``), or set in a Liquid
p
rompt config file.
Almost every feature in Liquid
P
rompt can be turned on or off using these config
options. They can either be set before sourcing Liquid
P
rompt (in ``.bashrc`` or
``.zshrc``), or set in a Liquid
P
rompt config file.
.. note::
Config variables set in a config file take precedence over variables set in the
...
...
@@ -26,7 +26,7 @@ The config file is searched for in the following locations:
The first file found is sourced.
Liquid
p
rompt ships with an example config file, ``liquidpromptrc-dist``. You can
Liquid
P
rompt ships with an example config file, ``liquidpromptrc-dist``. You can
start from this file for your config::
cp ~/liquidprompt/liquidpromptrc-dist ~/.config/liquidpromptrc
...
...
@@ -125,7 +125,7 @@ General
* **truncate_chars_from_path_left**: Truncates characters from the start of
the path, showing consecutive directories as one shortened section. E.g. in
a directory named ``~/MyProjects/Liquid
p
rompt/tests``, it will be shortened
a directory named ``~/MyProjects/Liquid
P
rompt/tests``, it will be shortened
to ``...prompt/tests``. The shortened mark is :attr:`LP_MARK_SHORTEN_PATH`.
* **truncate_chars_from_dir_right**: Leaves the beginning of a directory name
untouched. E.g. directories will be shortened like so: ``~/Doc.../Office``.
...
...
docs/functions.rst
View file @
4214b446
...
...
@@ -8,7 +8,7 @@ Functions starting with ``_lp`` are **theme** level functions, designed to be us
by themes. These include data, theme, and utility functions.
Functions starting with ``__lp`` are **internal** functions, designed to be used
only by Liquid
p
rompt internals. These functions should not be used by users or
only by Liquid
P
rompt internals. These functions should not be used by users or
themes, as they are not guaranteed to not change between versions.
.. toctree::
...
...
docs/functions/data/vcs.rst
View file @
4214b446
...
...
@@ -48,7 +48,7 @@ this.
.. function:: _lp_vcs_active()
Returns ``true`` if the detected VCS is enabled in Liquid
p
rompt and the
Returns ``true`` if the detected VCS is enabled in Liquid
P
rompt and the
current directory is a valid repository of that type. This check should be
done before running any other ``_lp_vcs_*`` data functions, but can be
omitted for speed reasons if the checks done by :func:`_lp_find_vcs` are good
...
...
@@ -255,7 +255,7 @@ Bazaar
.. function:: _lp_bzr_active()
Returns ``true`` if Bazaar is enabled in Liquid
p
rompt and the current
Returns ``true`` if Bazaar is enabled in Liquid
P
rompt and the current
directory is a valid Bazaar repository. This check should be done before
running any other ``_lp_bzr_*`` data functions if accessing the Bazaar
data functions directly instead of through the generic interface.
...
...
@@ -340,7 +340,7 @@ Fossil
.. function:: _lp_fossil_active()
Returns ``true`` if Fossil is enabled in Liquid
p
rompt and the current
Returns ``true`` if Fossil is enabled in Liquid
P
rompt and the current
directory is a valid Fossil repository. This check should be done before
running any other ``_lp_fossil_*`` data functions if accessing the Fossil
data functions directly instead of through the generic interface.
...
...
@@ -412,7 +412,7 @@ Git
.. function:: _lp_git_active()
Returns ``true`` if Git is enabled in Liquid
p
rompt and the current directory
Returns ``true`` if Git is enabled in Liquid
P
rompt and the current directory
is a valid Git repository. This check should be done before running any other
``_lp_git_*`` data functions if accessing the Git data functions directly
instead of through the generic interface.
...
...
@@ -542,7 +542,7 @@ Mercurial
.. function:: _lp_hg_active()
Returns ``true`` if Mercurial is enabled in Liquid
p
rompt and the current
Returns ``true`` if Mercurial is enabled in Liquid
P
rompt and the current
directory is a valid Mercurial repository. This check should be done before
running any other ``_lp_hg_*`` data functions if accessing the Mercurial data
functions directly instead of through the generic interface.
...
...
@@ -672,7 +672,7 @@ Subversion
.. function:: _lp_svn_active()
Returns ``true`` if Subversion is enabled in Liquid
p
rompt and the current
Returns ``true`` if Subversion is enabled in Liquid
P
rompt and the current
directory is a valid Subversion repository. This check should be done before
running any other ``_lp_svn_*`` data functions if accessing the Subversion
data functions directly instead of through the generic interface.
...
...
docs/functions/internal.rst
View file @
4214b446
...
...
@@ -4,10 +4,10 @@ Internal Functions
.. contents::
:local:
These functions are designed to be used only by Liquid
p
rompt internals and data
These functions are designed to be used only by Liquid
P
rompt internals and data
functions. These functions should not be used by users or themes, as they are
not guaranteed to be stable between versions. There are documented here for
information for those developing Liquid
p
rompt.
information for those developing Liquid
P
rompt.
Config
------
...
...
@@ -199,7 +199,7 @@ Theme
.. function:: __lp_theme_list() -> var:lp_theme_list
Returns an array of Liquid
p
rompt themes currently loaded in memory. Looks for
Returns an array of Liquid
P
rompt themes currently loaded in memory. Looks for
functions matching ``_lp_*_theme_prompt``.
.. versionadded:: 2.0
...
...
docs/index.rst
View file @
4214b446
.. Liquid
p
rompt documentation master file, created by
.. Liquid
P
rompt documentation master file, created by
sphinx-quickstart on Wed Nov 18 11:00:53 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Liquid
p
rompt's documentation!
Welcome to Liquid
P
rompt's documentation!
========================================
Liquid
p
rompt is an adaptive prompt for Bash & Zsh that gives you a nicely
Liquid
P
rompt is an adaptive prompt for Bash & Zsh that gives you a nicely
displayed prompt with useful information when you need it. It does this with a
powerful theming engine and a large array of data sources.
To get started, view the :doc:`install` documentation, which includes
instructions for trying Liquid
p
rompt temporarily.
instructions for trying Liquid
P
rompt temporarily.
.. toctree::
:maxdepth: 2
...
...
docs/install.rst
View file @
4214b446
...
...
@@ -47,7 +47,7 @@ following lines in your ``.zshrc`` after activating Zinit::
Dependencies
============
Liquid
p
rompt uses commands that should be available on a large variety of Unix
Liquid
P
rompt uses commands that should be available on a large variety of Unix
systems:
* ``awk``
...
...
@@ -85,10 +85,10 @@ Adjust the path if you installed to a different location that the suggested
Shell Installation
==================
To use Liquid
p
rompt every time you start a shell, add the following lines to
To use Liquid
P
rompt every time you start a shell, add the following lines to
your ``.bashrc`` (if you use Bash) or ``.zshrc`` (if you use zsh)::
# Only load Liquid
p
rompt in interactive shells, not from a script or from scp
# Only load Liquid
P
rompt in interactive shells, not from a script or from scp
[[ $- = *i* ]] && source ~/liquidprompt/liquidprompt
Adjust the path if you installed to a different location that the suggested
...
...
@@ -98,7 +98,7 @@ Adjust the path if you installed to a different location that the suggested
Check in your ``.bashrc`` that the :envvar:`PROMPT_COMMAND` variable is not
set, or else the prompt will not be available. If you must set it or use a
add-on that sets it, make sure to set :envvar:`PROMPT_COMMAND` **before** you
source Liquid
p
rompt to avoid history and timing issues. Do not export
source Liquid
P
rompt to avoid history and timing issues. Do not export
:envvar:`PROMPT_COMMAND`.
Next up are the :doc:`config`.
docs/install/packages.rst
View file @
4214b446
...
...
@@ -4,14 +4,14 @@ Packages
.. contents::
:local:
Liquid
p
rompt is packaged for many operating systems, though the latest version
Liquid
P
rompt is packaged for many operating systems, though the latest version
in those repositories is not always up to date.
Latest Versions
===============
.. image:: https://repology.org/badge/vertical-allrepos/liquidprompt.svg
:alt: Liquid
p
rompt packaging status
:alt: Liquid
P
rompt packaging status
Source: `repology.org <https://repology.org/project/liquidprompt/versions>`_.
...
...
@@ -56,11 +56,11 @@ used instead of the :ref:`shell-installation` instructions.
This will set the required environment:
* The files ``~/.bashrc`` and/or ``~/.zshrc`` are modified to load Liquid
p
rompt
* The files ``~/.bashrc`` and/or ``~/.zshrc`` are modified to load Liquid
P
rompt
at startup.
* If no previous ``~/.config/liquidpromptrc`` file exists, it will be created.
So, to get Liquid
p
rompt working simply run:
So, to get Liquid
P
rompt working simply run:
.. code-block::
...
...
docs/release-notes/v1.12.rst
View file @
4214b446
...
...
@@ -27,7 +27,7 @@ Preset Color Aliases
====================
The ``5`` value of the basic colors is often named "magenta", but in
Liquid
p
rompt it has always been "purple", and the bold version is "pink".
Liquid
P
rompt it has always been "purple", and the bold version is "pink".
To make the options more standard, an alias for ``PURPLE`` is ``MAGENTA``, and
``PINK`` now has aliases of ``BOLD_PURPLE`` and ``BOLD_MAGENTA``.
...
...
docs/release-notes/v2.0.rst
View file @
4214b446
...
...
@@ -24,7 +24,7 @@ See :doc:`../theme`.
Example Themes
==============
Liquid
p
rompt now ships with some example themes showcasing how the new theme
Liquid
P
rompt now ships with some example themes showcasing how the new theme
engine works. They are also fulling working themes that you can use as your
daily drivers.
See :doc:`../theme/included`.
...
...
@@ -32,7 +32,7 @@ See :doc:`../theme/included`.
Data Sources
============
To power the themes, all of the data sources in Liquid
p
rompt have been broken
To power the themes, all of the data sources in Liquid
P
rompt have been broken
out into individual data functions that can be called by themes. They are also
documented in detail in :doc:`../functions/data`.
...
...
@@ -61,9 +61,9 @@ See :doc:`../functions/theme`.
Version Control Tracking updates without directory change
=========================================================
Before, if ``git init`` or similar was run in a directory, Liquid
p
rompt would
Before, if ``git init`` or similar was run in a directory, Liquid
P
rompt would
not display any repository information until the current directory was changed.
Thanks to the speed improvements, Liquid
p
rompt now checks for a repository at
Thanks to the speed improvements, Liquid
P
rompt now checks for a repository at
each prompt, while still being faster than version 1.12.
Activate Function
...
...
docs/theme.rst
View file @
4214b446
Theming
*******
Liquid
p
rompt has a strong data and theming engine, allowing it to be extremely
Liquid
P
rompt has a strong data and theming engine, allowing it to be extremely
flexible and customizable.
The :doc:`theme/default` has a templating engine (previously called "themes" in
Liquid
p
rompt version 1), that allows for custom prompt ordering in the default
Liquid
P
rompt version 1), that allows for custom prompt ordering in the default
theme.
Liquid
p
rompt ships with some :doc:`theme/included` other than the default as
Liquid
P
rompt ships with some :doc:`theme/included` other than the default as
well.
See the `Liquid
p
rompt Theme List`_ on the wiki for user created themes.
See the `Liquid
P
rompt Theme List`_ on the wiki for user created themes.
If you want to create your own theme, see :doc:`theme/custom`.
.. _`Liquid
p
rompt Theme List`: https://github.com/nojhan/liquidprompt/wiki/Themes
.. _`Liquid
P
rompt Theme List`: https://github.com/nojhan/liquidprompt/wiki/Themes
.. toctree::
:maxdepth: 2
...
...
@@ -30,7 +30,7 @@ If you want to create your own theme, see :doc:`theme/custom`.
Switching Themes
----------------
Liquid
p
rompt can switch between themes on the fly. The shell does not need to be
Liquid
P
rompt can switch between themes on the fly. The shell does not need to be
reloaded, and no files need to be sourced after the initial source.
To load (but not activate) a theme, simply source the theme file. For example,
...
...
docs/theme/default.rst
View file @
4214b446
...
...
@@ -9,7 +9,7 @@ Preview
=======
If there is nothing special about the current context, the appearance of
Liquid
p
rompt is similar to that of a default prompt:
Liquid
P
rompt is similar to that of a default prompt:
.. image:: default-short.png
:alt: [user:~] $
...
...
@@ -20,7 +20,7 @@ Git repository on a server:
.. image:: default-med.png
:alt: 1& [user@server:~/liquidprompt] main ±
When Liquid
p
rompt is displaying nearly everything (a rare event!), it may look
When Liquid
P
rompt is displaying nearly everything (a rare event!), it may look
like this:
.. image:: default-long.png
...
...
@@ -57,7 +57,7 @@ to a variable, and can be arranged in any order in a template. If you want to
change the theme enough to move things around, but not enough to make your own
theme, templates will let you change the order of the default theme's pieces.
As the default theme of Liquid
p
rompt was the only theme until version 2.0,
As the default theme of Liquid
P
rompt was the only theme until version 2.0,
templates were sometimes referred to as "themes" in version 1.X.
For a template file to be loaded, its filepath must be set in
...
...
@@ -78,7 +78,7 @@ default order if the user does not configure a different template.
.. note::
Omitting a template section from your template will **not** disable that
feature. While it will not be displayed in the prompt, Liquid
p
rompt does not
feature. While it will not be displayed in the prompt, Liquid
P
rompt does not
know that, and will still generate that template section. If you want to
speed up your prompt by disabling a section, you must disable it with its
respective ``LP_ENABLE_*`` option.
...
...
docs/theme/included.rst
View file @
4214b446
Included Themes
***************
Liquid
p
rompt ships with some included themes that will have features added to
them as they are added to Liquid
p
rompt.
Liquid
P
rompt ships with some included themes that will have features added to
them as they are added to Liquid
P
rompt.
.. toctree::
:maxdepth: 2
...
...
docs/theme/included/alternate_vcs.rst
View file @
4214b446
...
...
@@ -36,7 +36,7 @@ Git repository on a server:
.. image:: alternate_vcs-med.png
:alt: 1& [user@server:~/liquidprompt] main ±
When Liquid
p
rompt is displaying nearly everything, it may look like this:
When Liquid
P
rompt is displaying nearly everything, it may look like this:
.. image:: alternate_vcs-long.png
:alt: 🕤 ⌁24% ⌂1.68 θ90° 3d/2&/1z [user@server:~/ … /liquidprompt/docs/theme ⚞3] [pyenv] main(U2 ?1 +10/-5,+3/-1)+ 20s 125 ±
...
...
@@ -49,9 +49,9 @@ A demo of what disabling the configuration options might look like:
Configuration
=============
Liquid
p
rompt Configuration
Liquid
P
rompt Configuration
--------------------------
All Liquid
p
rompt config options are respected, **except for**:
All Liquid
P
rompt config options are respected, **except for**:
* :attr:`LP_MARK_UNTRACKED` when :attr:`LP_ENABLE_ALT_VCS_STATUS` is enabled.
...
...
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment