Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-28 05:43:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: use parsed-literal to highlight interactive examples

Browse source 
There are a few code blocks where the default highlighting does not
work and the documentation looks bad as a result. Usually this happens
when we are demonstrating an important interactive feature, such as
autosuggestions, syntax highlighting, or tab completion.

The pygments highlighter was not designed for code samples like these.
But it is important to show the behavior clearly in the docs. I am
attempting to make these weird examples look as much like the "normal"
code blocks as possible.

https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal
This commit is contained in:
Charles Gould 2020-08-02 12:01:34 -04:00 committed by ridiculousfish
parent ac1f63781d
commit 2740473a65
3 changed files with 84 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc_src/_static/custom.css
View file

@ -1,5 +1,22 @@
.sphinxsidebar ul.current > li.current { font-weight: bold }
.gray { color: #555555 }
.purple { color: #551a8b }
.red { color: #FF0000 }
/* Color based on the Name.Function (.nf) class from pygments.css. */
.command { color: #005fd7 }
/* Color based on the Name.Constant (.no) class from pygments.css. */
.param { color: #00afff }
/* Color based on the Name.Constant (.no) class from pygments.css. */
/* Used for underlining file paths in interactive code examples. */
.param-valid-path { color: #00afff; text-decoration: underline }
/* Color based on the Generic.Prompt (.gp) class from pygments.css. */
.prompt { color: #8f5902 }
kbd {
background-color: #f9f9f9;
border: 1px solid #aaa;

5
doc_src/_static/pygments.css
View file

@ -77,8 +77,3 @@
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */
.purple { color: #551a8b }
.yellow { color: #FFFF00 }
.red { color: #FF0000 }
.gray { color: #555555 }
.underline { text-decoration: underline }

103
doc_src/tutorial.rst
View file

@ -84,26 +84,32 @@ Syntax Highlighting
.. role:: red
.. role:: gray
.. role:: underline
.. role:: prompt
.. role:: command
.. role:: param
.. role:: param-valid-path
You'll quickly notice that ``fish`` performs syntax highlighting as you type. Invalid commands are colored red by default
You'll quickly notice that fish performs syntax highlighting as you type. Invalid commands are colored red by default:
.. parsed-literal::
> :red:`/bin/mkd`
:prompt:`>` :red:`/bin/mkd`
A command may be invalid because it does not exist, or refers to a file that you cannot execute. When the command becomes valid, it is shown in a different color::
> /bin/mkdir
``fish`` will underline valid file paths as you type them
Valid file paths are underlined as you type them:
> cat :underline:`~/somefi`
.. parsed-literal::
:prompt:`>` :command:`cat` :param-valid-path:`~/somefi`
This tells you that there exists a file that starts with ``somefi``, which is useful feedback as you type.
These colors, and many more, can be changed by running ``fish_config``, or by modifying variables directly.
These colors, and many more, can be changed by running ``fish_config``, or by modifying :ref:`color variables <variables-color>` directly.
Wildcards
@ -160,19 +166,25 @@ To redirect stdout and stderr into one file, you need to first redirect stdout,
Autosuggestions
---------------
``fish`` suggests commands as you type, and shows the suggestion to the right of the cursor, in gray. For example
As you type fish will suggest commands to the right of the cursor, in gray. For example:
> :red:`/bin/h`:gray:`ostname`
.. parsed-literal::
:prompt:`>` :red:`/bin/h`:gray:`ostname`
It knows about paths and options
It knows about paths and options:
`> grep --i`:gray:`gnore-case`
.. parsed-literal::
:prompt:`>` :command:`grep` :param:`--i`:gray:`gnore-case`
And history too. Type a command once, and you can re-summon it by just typing a few letters
And history too. Type a command once, and you can re-summon it by just typing a few letters:
> :red:`r`:gray:`sync -avze ssh . myname@somelonghost.com:/some/long/path/doo/dee/doo/dee/doo`
.. parsed-literal::
:prompt:`>` :red:`r`:gray:`sync -avze ssh . myname@somelonghost.com:/some/long/path/doo/dee/doo/dee/doo`
To accept the autosuggestion, hit :kbd:`→` (right arrow) or :kbd:`Control`\ +\ :kbd:`F`. To accept a single word of the autosuggestion, :kbd:`Alt`\ +\ :kbd:`→` (right arrow). If the autosuggestion is not what you want, just ignore it.
@ -180,29 +192,35 @@ To accept the autosuggestion, hit :kbd:`→` (right arrow) or :kbd:`Control`\ +\
Tab Completions
---------------
``fish`` comes with a rich set of tab completions, that work "out of the box."
A rich set of tab completions work "out of the box".
Press :kbd:`Tab`, and ``fish`` will attempt to complete the command, argument, or path
Press :kbd:`Tab` and fish will attempt to complete the command, argument, or path:
> :red:`/pri` :kbd:`Tab` => /private/
.. parsed-literal::
:prompt:`>` :red:`/pri`:kbd:`Tab` => :command:`/private/`
If there's more than one possibility, it will list them
If there's more than one possibility, it will list them:
> :red:`~/stuff/s` :kbd:`Tab`
~/stuff/script.sh (Executable, 4.8kB) ~/stuff/sources/ (Directory)
.. parsed-literal::
:prompt:`>` :red:`~/stuff/s`:kbd:`Tab`
~/stuff/script.sh (Executable, 4.8kB) ~/stuff/sources/ (Directory)
Hit tab again to cycle through the possibilities.
``fish`` can also complete many commands, like git branches::
fish can also complete many commands, like git branches:
> git merge pr :kbd:`Tab` => git merge prompt_designer
> git checkout b :kbd:`Tab`
.. parsed-literal::
:prompt:`>` :command:`git` :param:`merge pr`:kbd:`Tab` => :command:`git` :param:`merge prompt_designer`
:prompt:`>` :command:`git` :param:`checkout b`:kbd:`Tab`
builtin_list_io_merge (Branch) builtin_set_color (Branch) busted_events (Tag)
Try hitting tab and see what ``fish`` can do!
Try hitting tab and see what fish can do!
Variables
---------
@ -574,34 +592,39 @@ Iterating over a list of numbers can be done with ``seq``::
Prompt
------
Unlike other shells, there is no prompt variable like PS1. To display your prompt, ``fish`` executes a function with the name ``fish_prompt``, and its output is used as the prompt.
You can define your own prompt::
> function fish_prompt
echo "New Prompt % "
end
New Prompt %
.. role:: purple
.. role:: yellow
Multiple lines are OK. Colors can be set via ``set_color``, passing it named ANSI colors, or hex RGB values::
Unlike other shells, there is no prompt variable like ``PS1``. To display your prompt, fish executes the :ref:`fish_prompt <cmd-fish_prompt>` function and uses its output as the prompt. And if it exists, fish also executes the :ref:`fish_right_prompt <cmd-fish_right_prompt>` function and uses its output as the right prompt.
> function fish_prompt
You can define your own prompt from the command line:
.. parsed-literal::
> function fish_prompt; echo "New Prompt % "; end
New Prompt % _
Then, if you are happy with it, you can save it to disk by typing ``funcsave fish_prompt``. This saves the prompt in ``~/.config/fish/functions/fish_prompt.fish``. (Or, if you want, you can create that file manually from the start.)
Multiple lines are OK. Colors can be set via :ref:`set_color <cmd-set_color>`, passing it named ANSI colors, or hex RGB values::
function fish_prompt
set_color purple
date "+%m/%d/%y"
set_color FF0
set_color F00
echo (pwd) '>' (set_color normal)
end
will look like
| :purple:`02/06/13`
| :yellow:`/home/tutorial >`
This prompt would look like:
You can choose among some sample prompts by running ``fish_config prompt``. ``fish`` also supports RPROMPT through ``fish_right_prompt``.
.. parsed-literal::
:purple:`02/06/13`
:red:`/home/tutorial >` _
You can choose among some sample prompts by running ``fish_config prompt``.
$PATH
-----