feat(theme): explain #856
feat(theme): explain #856
Conversation
nojhan
added
the
theme
Adds a theme that displays the name of each of the prompt sections, along with a clickable hyperlink to the corresponding documentation.
nojhan
force-pushed
the
theme-explain
branch
from
7e1b91f to
2e137cf
Compare
There was a problem hiding this comment.
The screenshots of the other themes use the tools/theme-preview.sh script, because it mocks the data functions to have generic and consistent data. Please update these images to use that as well.
If you used your own environment because that script does not demo the features as well as you want, then I think we need to update the mocked data in the script.
| ************* | ||
|
|
||
| The included ``themes/explain/explain.theme`` file includes a theme that | ||
| add a label to each section of the default theme, along with a clickable link |
There was a problem hiding this comment.
| add a label to each section of the default theme, along with a clickable link | |
| adds a label to each section of the default theme, along with a clickable link |
| Liquid Prompt configuration | ||
| --------------------------- | ||
|
|
||
| The LP_ENABLE_HYPERLINKS configuration variable should be set to 1 for the |
There was a problem hiding this comment.
Needs to be linked
| The LP_ENABLE_HYPERLINKS configuration variable should be set to 1 for the | |
| The :attr:`LP_ENABLE_HYPERLINKS` configuration variable should be set to 1 for the |
| points to the variable ``LP_BRACKET_OPEN``, as documented on the following page: | ||
| https://liquidprompt.readthedocs.io/en/stable/theme/default.html |
There was a problem hiding this comment.
No need for a manual link.
| points to the variable ``LP_BRACKET_OPEN``, as documented on the following page: | |
| https://liquidprompt.readthedocs.io/en/stable/theme/default.html | |
| points to the variable :attr:`LP_BRACKET_OPEN`. |
| points to the variable ``LP_BRACKET_OPEN``, as documented on the following page: | ||
| https://liquidprompt.readthedocs.io/en/stable/theme/default.html | ||
|
|
||
| Unless explicitly set, *explain* will set LP_MARK_PREFIX as a single newline. |
There was a problem hiding this comment.
| Unless explicitly set, *explain* will set LP_MARK_PREFIX as a single newline. | |
| Unless explicitly set, *explain* will set :attr:`LP_MARK_PREFIX` as a single newline. |
| - ``LP_MARK_DEV_OPEN`` | ||
| - ``LP_MARK_DEV_CLOSE`` | ||
| - ``LP_MARK_DEV_MID`` | ||
| - ``LP_MARK_MODULES_OPEN`` | ||
| - ``LP_MARK_MODULES_SEP`` | ||
| - ``LP_MARK_MODULES_CLOSE`` | ||
| - ``LP_MARK_ENV_VARS_OPEN`` | ||
| - ``LP_MARK_ENV_VARS_SEP`` | ||
| - ``LP_MARK_ENV_VARS_CLOSE`` |
There was a problem hiding this comment.
Might as well let these be linked:
| - ``LP_MARK_DEV_OPEN`` | |
| - ``LP_MARK_DEV_CLOSE`` | |
| - ``LP_MARK_DEV_MID`` | |
| - ``LP_MARK_MODULES_OPEN`` | |
| - ``LP_MARK_MODULES_SEP`` | |
| - ``LP_MARK_MODULES_CLOSE`` | |
| - ``LP_MARK_ENV_VARS_OPEN`` | |
| - ``LP_MARK_ENV_VARS_SEP`` | |
| - ``LP_MARK_ENV_VARS_CLOSE`` | |
| - :attr:`LP_MARK_DEV_OPEN` | |
| - :attr:`LP_MARK_DEV_CLOSE` | |
| - :attr:`LP_MARK_DEV_MID` | |
| - :attr:`LP_MARK_MODULES_OPEN` | |
| - :attr:`LP_MARK_MODULES_SEP` | |
| - :attr:`LP_MARK_MODULES_CLOSE` | |
| - :attr:`LP_MARK_ENV_VARS_OPEN` | |
| - :attr:`LP_MARK_ENV_VARS_SEP` | |
| - :attr:`LP_MARK_ENV_VARS_CLOSE` |
| LP_EXPLAIN_MARK_BODY_TOP=━ | ||
| LP_EXPLAIN_MARK_BODY_BOTTOM=━ | ||
|
|
||
| LP_MARK_PREFIX=$'\n' |
There was a problem hiding this comment.
Why do only some of these files have this line? I don't see why they need it at all, since it is the default anyway.
| The ``themes/explain/preset-chevrons.conf`` preset requires a font supporting | ||
| "Box Drawings Diagonal" characters (approved as part of Unicode version 1.1 | ||
| in 1993): |
There was a problem hiding this comment.
This is not quite true. While ┴, ┌, and ─ were added in Unicode v1.1, 🮠, 🮡, 🮢, 🮣, 🮤, and 🮥 were added in Unicode v13.0, which was released in 2020. None of my devices have been able to render those (Windows 11, MacOS 14.7, Android 14).
I recommend finding some older characters that look similar. If that is not possible, update this docs section, and consider adding a link to a font that supports those characters.
Adds a theme that displays the name of each of the prompt sections, along with a clickable hyperlink to the corresponding documentation.